Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add CONTRIBUTING file with contributor guidelines #2705

Draft
wants to merge 8 commits into
base: fix/docs
Choose a base branch
from
Draft
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## How to contribute to RMG-Py

Thank you for contributing to RMG-Py! Please take a moment to review our guidelines:

#### **Did you find a bug?**

* ** Example...**

* Please include in the ISSUES page.

* For more detailed information on submitting a bug report and creating an issue, visit our [reporting guidelines](https://example.com).

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

* Open a new GitHub PR to merge into the main branch.

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

* Your PR must pass unit tests, regression tests, and code coverage, and receive approval from a reviewer before it can be merged in.

#### **Do you want to see a new feature added?**

* Suggest your change in the Issues tab.

#### **Do you have questions?**

* Email us at rmg_dev@mit.edu.

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

* Example here...

### Best practices for PRs:

* Rebase to the main branch before working, to avoid merge conflicts.

* Keep PRs small and aim to merge quickly.

* 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.

* 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.


Thank you!
RMG Developers
Loading