From 8c4b6d3e39f924afc683176096a50312438a8b8b Mon Sep 17 00:00:00 2001 From: Simon Gravelle Date: Thu, 29 Aug 2024 11:39:17 +0200 Subject: [PATCH] updated contrib --- CONTRIBUTING.md | 6 ++++++ README.md | 6 ------ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e33324..8c58e02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 4173804..95847d9 100644 --- a/README.md +++ b/README.md @@ -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