Skip to content

Commit c4d8cfb

Browse files
committed
docs: clarify pr creation process
1 parent d71b2cf commit c4d8cfb

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

HOW_TO_CONTRIBUTE.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,18 @@ Please note we have a [code of conduct](/CODE_OF_CONDUCT.md), please follow it i
66

77
## Pull Request process
88

9+
Pull requests should be made by forking the repository, making the changes, and requesting to merge back.
10+
All pull requests should branch off of the `dev` branch with a descriptive prefix, e.g. `feat/new_feature` or `fix/fix_issue_number`.
11+
Additionally, all pull requests should target back into the `dev` branch.
12+
13+
Once you have a new branch with the appropriate name, originating from `dev`, on a fork of the repository, complete the following steps.
14+
915
1. Download the dependencies in the developer [requirements file](/requirements/developer.txt).
1016
2. Add unit tests for features being added or bugs being fixed.
1117
3. Include any new method/function in the corresponding docs file.
1218
4. Run `pytest` to verify all unit tests pass. (To see what lines are covered, read the [`pytest-cov`](https://pytest-cov.readthedocs.io/en/latest/reporting.html) documentation.)
1319
5. [OPTIONAL] Format codebase according to the steps below.
14-
6. Submit Pull Request with a list of changes, links to issues that it addresses (if applicable)
20+
6. Submit pull request with a list of changes, links to issues that it addresses (if applicable)
1521
7. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.
1622

1723
## Format codebase

0 commit comments

Comments
 (0)