Skip to content

Commit 8c4b6d3

Browse files
committed
updated contrib
1 parent 179d70d commit 8c4b6d3

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ Once you've made your changes:
3333
Only PRs that pass all tests will be merged into the main branch. Please ensure
3434
that your code passes all existing tests from the *tests/* folder.
3535

36+
The [tests/](tests/) folder contains a series of tests for the Python code written in the
37+
documentation. In short, the Python code is extracted from the documentation.
38+
Only the Python script written in between labels similar to *label:: start_myfile_class*
39+
will be converted to the code. This is used to ensuring that the code from the
40+
documentation is always valid as well as up to date.
41+
3642
### 6. Code Review
3743
Your PR will undergo a code review. Feedback will be provided, and some revisions
3844
may be requested. Once all issues are addressed and all tests pass, your PR will

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ We welcome contributions from the community. Before you start, please read our
2222
[Contributing Guidelines](./CONTRIBUTING.md). These guidelines will help you
2323
understand the process and expectations for contributing to the project.
2424

25-
### Automated tests
26-
27-
The [tests/](tests/) folder contains a series of tests for the Python code written in the
28-
documentation. In short, the Python code is extracted from the documentation
29-
and executed, thus ensuring that the code from the documentation is always valid.
30-
3125
### Prerequisite
3226

3327
The target audience includes people who are either completely new to molecular simulations

0 commit comments

Comments
 (0)