Skip to content

contributing_guidelines.md

Latest commit

 

History

History
34 lines (21 loc) · 1.57 KB

contributing_guidelines.md

File metadata and controls

34 lines (21 loc) · 1.57 KB
Raw

Creating a Pull Request

Table of Contents

1. Fork the repository

2. Clone the original repository to your local PC using one of the following commands based on the protocol you are using:

  • HTTPS:git clone https://github.com/CodeForBoulder/Kalicos.git --origin upstream
  • SSH:git clone git@github.com:CodeForBoulder/Kalicos.git --origin upstream
  • Then rebase: git rebase upstream master If you use HTTPS, you will have to log in each time when pushing to your fork. (Recommended: learn about git SSH support, it logs in automatically using SSH keys)

3. Add your fork with

  • HTTPS:git remote add origin https://github.com/your-username/Kalicos.git
  • SSH:git remote add origin git@github.com:your-username/Kalicos.git

4. Alternatively, if you already have a fork and copy of the repo, you can simply check to make sure you're up-to-date

  • Pull the upstream:git pull upstream --rebase

5. Create a separate branch (recommended if you're making multiple changes simultaneously) (git checkout -b my-branch)

6. Make changes

7. Commit (git add <item(s) you changed>; git commit) and write your commit message

8. Pull from upstream (git pull upstream --rebase) (Note: Make sure to include --rebase, as it will apply your changes on top of the changes you just pulled, allowing for a much cleaner merge)

9. Push to your fork (git push origin <branch>), <branch> being the branch you created earlier

10. Create a pull request

11. Describe pull request

12. Submit!