Skip to content

Commit

Permalink
ask for PRs from forked repos to be synced
Browse files Browse the repository at this point in the history
  • Loading branch information
aryarm authored Jul 13, 2021
1 parent 9e9b2d7 commit a17a6a3
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,19 @@ Please create a pull request! A PR is a collection of changes that you have made
To create a pull request you need to do these steps:

1. Create a Github account.
2. Fork the repository. Click the "Fork" button in the top, right corner.
3. Clone your fork locally.
4. `cd varCA` into the new directory
5. Create a new branch with `git checkout -b <descriptive_branch_name>`
6. Make your changes to the code.
7. Test that they work. And test your code with any existing tests in the repository to ensure you haven't broken anything. See "Testing" below.
8. If needed, please add any comments to the documentation that would help users understand how to use your new code.
9. Commit your changes. Please use informative commit messages and do your best to ensure the commit history is clean and easy to interpret.
10. Now you can push your changes to your Github copy of varCA by running `git push origin <descriptive_branch_name>`
11. Go to your Github copy of varCA in your browser and create a pull request. Be sure to change the pull request target branch to `master` on this original repository!
12. Please write an informative pull request detailing the changes you have made and why you made them. Tag any related issues by referring to them by a hashtag followed by their ID.
2. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the repository.
- Click the "Fork" button in the top, right corner
- Or, if you had already forked the repository a while ago, [sync your fork](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to make sure you're working with the latest version of varCA.
4. [Clone your fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) locally.
5. `cd varCA` into the new directory
6. Create a new branch with `git checkout -b <descriptive_branch_name>`
7. Make your changes to the code.
8. Test that they work. And test your code with any existing tests in the repository to ensure you haven't broken anything. See "Testing" below.
9. Please add any comments to the documentation that would help users understand how to use your new code.
10. Commit your changes. Please use informative commit messages and do your best to ensure the commit history is clean and easy to interpret.
11. Now you can push your changes to your Github copy of varCA by running `git push origin <descriptive_branch_name>`
12. Go to your Github copy of varCA in your browser and create a pull request. Be sure to change the pull request target branch to `master` on this original repository!
13. Please write an informative pull request detailing the changes you have made and why you made them. Tag any related issues by referring to them by a hashtag followed by their ID.

### Testing
It's critical that you test your new code to make sure that you're not inadvertantly introducing any new bugs.
Expand Down

0 comments on commit a17a6a3

Please sign in to comment.