Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

31 lines (28 loc) · 1.64 KB
Raw

Contributing to RideSafe 🛠️

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Making a Pull Request (PR) using Branches 🌳

  1. Fork the Repository: Start by forking the RideSafe repository to your own GitHub account.
  2. Clone the Forked Repository: Clone your fork to your local machine using the command:
git clone https://github.com/<your-username>/RideSafe.git
  1. Create a New Branch: Navigate to the project directory and create a new branch for your feature or bug fix:
git checkout -b <branch-name>
  1. Make Your Changes: Make the necessary changes in the code.
  2. Commit Your Changes: Commit your changes with a meaningful commit message:
git commit -m "Describe the changes made in this commit"
  1. Push to GitHub: Push your branch to GitHub:
git push origin <branch-name>
  1. Create a Pull Request: Go to the RideSafe GitHub page, switch to your newly pushed branch, and click on 'New Pull Request'. Explain the purpose of your PR and the changes you made in the description.
  2. Wait for Review: Wait for the maintainers to review your PR. They may suggest some changes. Incorporate any feedback, and push the updates to the same branch on your fork. This will automatically update the PR.
  3. Get Merged!: Once approved, your PR will be merged into the main branch. Congratulations, and thank you for your contribution! 🎉