Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

87 lines (58 loc) · 3.83 KB
Raw

Contributing to Uber-like App

🚀 How to Contribute to This Project 🚀

We’re excited to have you contribute to this Uber Like Website project! Follow these simple steps to get started:

  1. 🍴 Fork the Repository

    • Go to the repository page.
    • Click the Fork button (top right). This creates a copy of the project in your GitHub account.

  2. 💻 Clone Your Fork

    • Once the repository is forked, clone it to your local machine. Open your terminal and run:
     git clone https://github.com/your-username/Uber-like.git
cd uber-like
    • Replace your-username with your GitHub username.

  3. 🌿 Create a New Branch

    • Before making any changes, create a new branch for your work:
     git checkout -b your-branch-name
    • Choose a branch name that describes what you're working on, such as fix-navbar or add-contact-form.

  4. 🛠️ Make Your Changes

    • Open the project files in your code editor (like VS Code) and make your changes.
    • You can contact the project manager for any queiries you have.

  5. ✅ Test Your Changes

    • Make sure your changes work correctly by testing the website locally. Open the index.html file in your browser to see your updates.

  6. 💬 Commit Your Changes

    • Once your changes are ready, commit them with a descriptive message: 
      git add .
git commit -m "Added feature X or Fixed issue Y"

  7. 📤 Push Your Changes

    • Push your changes to your forked repository on GitHub:
     git push origin your-branch-name

  8. 🔄 Create a Pull Request (PR)

    • Go back to the original repository here.
    • Click the Compare & pull request button.
    • Write a short description of your changes and submit the pull request (PR).

  9. 🔎Review Changes

    • The project manager will review your PR. If your changes are approved, your request would be merged.

By following these steps, you can easily contribute to this project! If you have any questions, feel free to ask in the repository’s discussion or issue section.

Code of Conduct

We follow a Code of Conduct in this project to ensure a welcoming and respectful environment for everyone. By participating in this project, you agree to uphold these standards.

Issues

We use GitHub Issues to track bugs, features, and discussions. Before opening a new issue, please:

Search for existing issues: Use the search feature to ensure that your issue hasn't already been reported or addressed.

Be descriptive: When opening a new issue, please provide a clear and detailed description of the problem or feature request. If applicable, include steps to reproduce, expected behavior, and actual behavior.

Submitting a Pull Request

When submitting a pull request (PR), please follow these guidelines:

  1. Ensure your changes are in a new branch: Do not make changes directly to the main branch.

  2. Write clear commit messages: Your commit message should describe the changes you’ve made, and why you made them.

  3. Provide context: In the PR description, provide context for the changes you’ve made. This helps reviewers understand the purpose of your changes.

  4. Link issues: If your PR addresses an open issue, include a reference to it in your PR description. For example: Fixes #123.

  5. Follow coding conventions: Ensure that your code follows the existing coding standards used in the repository. This includes indentation, variable naming, and file structure.

Need Help?

If you have questions or need clarification, feel free to reach out to the project maintainers by opening an issue or emailing us directly ([email protected]).