|
1 | 1 | ## How to contribute to RMG-Py |
2 | 2 |
|
| 3 | +Thank you for contributing to RMG-Py! Please take a moment to review our guidelines: |
| 4 | + |
3 | 5 | #### **Did you find a bug?** |
4 | 6 |
|
5 | 7 | * ** Example...** |
6 | 8 |
|
| 9 | +* Please include in the ISSUES page. |
| 10 | + |
7 | 11 | * For more detailed information on submitting a bug report and creating an issue, visit our [reporting guidelines](https://example.com). |
8 | 12 |
|
9 | 13 | #### **Did you write code that fixes a bug?** |
10 | 14 |
|
11 | | -* Open a new GitHub pull request with your changes. |
| 15 | +* Open a new GitHub PR to merge into the main branch. |
12 | 16 |
|
13 | 17 | * Make sure the PR clearly describes the problem + solution. If applicable, include the relevant issue. |
14 | 18 |
|
| 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 | + |
15 | 21 | #### **Do you want to see a new feature added?** |
16 | 22 |
|
17 | | -* Suggest your change in the Issues tab |
| 23 | +* Suggest your change in the Issues tab. |
18 | 24 |
|
19 | 25 | #### **Do you have questions?** |
20 | 26 |
|
21 | | -* Ex. |
| 27 | +* Email us at rmg_dev@mit.edu. |
22 | 28 |
|
23 | 29 | #### **Do you want to contribute to the documentation?** |
24 | 30 |
|
25 | 31 | * Example here... |
26 | 32 |
|
| 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! |
27 | 45 | RMG Developers |
0 commit comments