Skip to content

Commit 417098a

Browse files
committed
added Guideline for contributors
1 parent 13ce0eb commit 417098a

File tree

2 files changed

+47
-2
lines changed

2 files changed

+47
-2
lines changed

CONTRIBUTING.md

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

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ The Python code that is written here is used to realize molecular
1616
scientific projects. Note that the code is slow and that efficiency is not the
1717
primary objective here.
1818

19+
### Contributing
20+
21+
We welcome contributions from the community. Before you start, please read our
22+
[Contributing Guidelines](./CONTRIBUTING.md). These guidelines will help you
23+
understand the process and expectations for contributing to the project.
24+
1925
### Automated tests
2026

2127
The [tests/](tests/) folder contains a series of tests for the Python code written in the
@@ -35,6 +41,8 @@ readings are provided as needed.
3541
### What is not (yet) in the code
3642

3743
- molecules/shake,
44+
- electrostatic
45+
- Monte Carlo
3846
- thermostats and barostats other than Berendsen,
3947
- energy minimization methods other than the steepest descent.
4048

@@ -63,5 +71,3 @@ GNU general public license v3.0.
6371
- Choose a different title? (Build Your Own Molecular Simulations with Python,
6472
Create Molecular Simulations with Python, Construct Molecular Simulations with Python)
6573
- Find a cool acronym. MS-PyLearn, LMS-py ?
66-
- add references
67-
- implement Nose-Hoover?

0 commit comments

Comments
 (0)