Skip to content

Commit

Permalink
updated contrib
Browse files Browse the repository at this point in the history
  • Loading branch information
simongravelle committed Aug 29, 2024
1 parent 179d70d commit 8c4b6d3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ Once you've made your changes:
Only PRs that pass all tests will be merged into the main branch. Please ensure
that your code passes all existing tests from the *tests/* folder.

The [tests/](tests/) folder contains a series of tests for the Python code written in the
documentation. In short, the Python code is extracted from the documentation.
Only the Python script written in between labels similar to *label:: start_myfile_class*
will be converted to the code. This is used to ensuring that the code from the
documentation is always valid as well as up to date.

### 6. Code Review
Your PR will undergo a code review. Feedback will be provided, and some revisions
may be requested. Once all issues are addressed and all tests pass, your PR will
Expand Down
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ We welcome contributions from the community. Before you start, please read our
[Contributing Guidelines](./CONTRIBUTING.md). These guidelines will help you
understand the process and expectations for contributing to the project.

### Automated tests

The [tests/](tests/) folder contains a series of tests for the Python code written in the
documentation. In short, the Python code is extracted from the documentation
and executed, thus ensuring that the code from the documentation is always valid.

### Prerequisite

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

0 comments on commit 8c4b6d3

Please sign in to comment.