add fork, clone and adding remotes to the PR steps
Contributing to vcf-validator
==========================
-We welcome community contributions to vcf-validator! To build tool locally, follow the instructions in the [README.md file](https://github.com/EBIvariation/vcf-validator/blob/master/README.md).
+We welcome community contributions to vcf-validator!
+
+
+## Bug reports & troubleshooting
+
+If you are submitting a bug, please go to [this link](https://github.com/EBIvariation/vcf-validator/issues/new)
## First Timers Welcome!
-New to open source? Here is a selection of issues we've made especially for first-timers. Follow this [link](https://github.com/EBIvariation/vcf-validator/issues?q=is%3Aissue+is%3Aopen+label%3Abeginner).
+To build tool locally, follow the instructions in the [README.md file](https://github.com/EBIvariation/vcf-validator/blob/master/README.md). New to open source? Here is a selection of issues we've made especially for first-timers. Follow this [link](https://github.com/EBIvariation/vcf-validator/issues?q=is%3Aissue+is%3Aopen+label%3Abeginner).
## Making a New PR
Once you found an interesting issue to work on you may check if someone other is not working on the same issue. You can ask once in the issue to get that issue assigned to you. Once you get an approval go for the PR. While making a new PR do follow these norms:
+- Fork and `git clone` the repository if you haven't done so.
+- Add EBIvariation as "upstream" remote: `git remote add upstream https://github.com/EBIvariation/vcf-validator.git`
- Fetch the latest changes by `git fetch upstream`.
- Update the local develop branch `git rebase upstream/develop develop`.
- Create a new branch from develop `git checkout -b <branch_name> develop`.
@@ -31,7 +38,3 @@ There are some coding practices that we follow to make code easily readable and
- Avoid Deep Nesting - Too many levels of nesting make code harder to read.
- Limit Line Length - It is a good practice to avoid writing horizontally long lines of code. There is no such limit but still having max lenght till 80 is good practice. For more follow this [link](https://stackoverflow.com/a/111009/6799074).
- Bracket Style - We generally use attached brackets for `conditions` and `loops` and broken brackets for `functions` and `classes`. Our style is a variant of [K&R style : variant](https://en.wikipedia.org/wiki/Indentation_style#K&R), difference is that we force use of brackets even if there is single statement in the brackets.
-
-## Bug reports & troubleshooting
-
-If you are submitting a bug, please go to [this link](https://github.com/EBIvariation/vcf-validator/issues/new)
