|
1 | 1 | # Contributing to RFDpoly |
| 2 | +Thank you for helping RFDpoly grow! Please follow the |
| 3 | +guidelines below to ensure the consistency of the code |
| 4 | +and documentation quality. |
| 5 | + |
| 6 | +To contribute to RFDpoly - either through code or |
| 7 | +documentation contributions - please fork the repository, |
| 8 | +make changes, and create a pull request (PR). The pull |
| 9 | +request should have `main` as the base branch. |
| 10 | + |
| 11 | +If your PR is a result of an Issue or Discussion, make |
| 12 | +sure to mention it in your description. |
| 13 | + |
| 14 | +## Issues vs. Discussions |
| 15 | +An issue should be opened if there is an issue with the |
| 16 | +code or there is a request for a new feature. |
| 17 | + |
| 18 | +The Discussions section should be used to answer questions |
| 19 | +about best practices, usage, etc. |
2 | 20 |
|
3 | 21 | ## Code Contributions |
4 | 22 |
|
| 23 | +### Code Style and Quality |
| 24 | +When contributing to the code base, please adhere to the [PEP8 style guide](https://peps.python.org/pep-0008/). |
| 25 | + |
| 26 | +### Tests |
| 27 | +Please write tests for any contributed code or append to |
| 28 | +existing tests. |
| 29 | + |
| 30 | +### Approving and Merging Pull Requests |
| 31 | +Currently only the original developers and the Devel Team |
| 32 | +at Rosetta Commons can approve and merge pull requests. PRs |
| 33 | +will be merged via a merge commit, so all commits from the |
| 34 | +feature branch will be added to the base branch. |
| 35 | + |
5 | 36 | ## Documentation Contributions |
6 | 37 |
|
7 | 38 | To preview the changes you made to the documentation before making a Pull Request you will need to |
|
0 commit comments