Skip to content

Commit 8aeb7f7

Browse files
committed
Update CONTRIBUTING.md with detailed guidelines
Expanded the contributing guide to include instructions for forking, pull requests, referencing issues, and distinguishing between Issues and Discussions. Added sections on code style (PEP8), testing requirements, and pull request approval process to improve clarity for contributors.
1 parent 78e5bd7 commit 8aeb7f7

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,38 @@
11
# 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.
220

321
## Code Contributions
422

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+
536
## Documentation Contributions
637

738
To preview the changes you made to the documentation before making a Pull Request you will need to

0 commit comments

Comments
 (0)