|
| 1 | +# Contributing to Learn Molecular Simulations with Python |
| 2 | + |
| 3 | +## How to Contribute |
| 4 | + |
| 5 | +### 1. Raise an Issue First |
| 6 | + |
| 7 | +Before making any changes or submitting a pull request (PR), **please open an issue** |
| 8 | +to discuss the proposed changes or features. This helps us ensure that: |
| 9 | +- Your idea aligns with the project’s goals. |
| 10 | +- There is no duplicate effort by other contributors. |
| 11 | +- We can provide feedback or suggestions before you start working. |
| 12 | + |
| 13 | +You can open an issue by [clicking here](./issues). |
| 14 | + |
| 15 | +### 2. Fork the Repository |
| 16 | + |
| 17 | +After your issue has been discussed and agreed upon, you can fork the repository |
| 18 | +and start working on your changes. |
| 19 | + |
| 20 | +### 3. Write Clear, Concise Commit Messages |
| 21 | + |
| 22 | +Each commit message should clearly describe what changes were made and why. |
| 23 | +This helps maintain a clean and understandable project history. |
| 24 | + |
| 25 | +### 4. Submit a Pull Request (PR) |
| 26 | + |
| 27 | +Once you've made your changes: |
| 28 | +- Push your changes to your fork. |
| 29 | +- Submit a PR to the main repository. |
| 30 | + |
| 31 | +### 5. Passing Tests is Mandatory |
| 32 | + |
| 33 | +Only PRs that pass all tests will be merged into the main branch. Please ensure |
| 34 | +that your code passes all existing tests from the *tests/* folder. |
| 35 | + |
| 36 | +### 6. Code Review |
| 37 | +Your PR will undergo a code review. Feedback will be provided, and some revisions |
| 38 | +may be requested. Once all issues are addressed and all tests pass, your PR will |
| 39 | +be merged. |
0 commit comments