Skip to content

Commit 8314427

Browse files
committed
add some contributor guidelines
1 parent 86488ea commit 8314427

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,45 @@
11
## How to contribute to RMG-Py
22

3+
Thank you for contributing to RMG-Py! Please take a moment to review our guidelines:
4+
35
#### **Did you find a bug?**
46

57
* ** Example...**
68

9+
* Please include in the ISSUES page.
10+
711
* For more detailed information on submitting a bug report and creating an issue, visit our [reporting guidelines](https://example.com).
812

913
#### **Did you write code that fixes a bug?**
1014

11-
* Open a new GitHub pull request with your changes.
15+
* Open a new GitHub PR to merge into the main branch.
1216

1317
* Make sure the PR clearly describes the problem + solution. If applicable, include the relevant issue.
1418

19+
* Your PR must pass unit tests, regression tests, and code coverage, and receive approval from a reviewer before it can be merged in.
20+
1521
#### **Do you want to see a new feature added?**
1622

17-
* Suggest your change in the Issues tab
23+
* Suggest your change in the Issues tab.
1824

1925
#### **Do you have questions?**
2026

21-
* Ex.
27+
* Email us at rmg_dev@mit.edu.
2228

2329
#### **Do you want to contribute to the documentation?**
2430

2531
* Example here...
2632

33+
### Best practices for PRs:
34+
35+
* Rebase to the main branch before working, to avoid merge conflicts.
36+
37+
* Keep PRs small and aim to merge quickly.
38+
39+
* Submit a PR only when the code is polished and ready for review. Consider opening a draft PR for work in progress that requires collaborator input.
40+
41+
* For complex, multi-step PRs, consider opening "megathread" PRs pointing to the main branch. Then, create other PRs that merge into the "megathread" PR branch. This helps divide the review process into smaller chunks.
42+
43+
44+
Thank you!
2745
RMG Developers

0 commit comments

Comments
 (0)