From dd5584b88e46274d0348a15f2c78854d2593c0d3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 21 Jul 2024 20:58:05 +0800 Subject: [PATCH] Added: - Updated `Contribution.rst` to include context on running tests and code style checks. --- doc/source/Contribution.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/doc/source/Contribution.rst b/doc/source/Contribution.rst index d99b07f..ce9d6dd 100644 --- a/doc/source/Contribution.rst +++ b/doc/source/Contribution.rst @@ -24,11 +24,24 @@ Development Process Make changes in your branch. Once you've made improvements or bug fixes to the project, commit the changes with a meaningful commit message. -5. **Start a Pull Request** +5. **Run Tests** + To execute all tests, navigate to the root directory of PREP-SHOT and run: + +.. code:: bash + + python -m unittest discover -s tests + +To check your code for PEP8 compliance, run: + +.. code:: bash + pylint run.py + pylint prepshot + +6. **Start a Pull Request** Open a `pull request `_ from your forked repository to the main PREP-SHOT repository. Describe your changes in the pull request. -6. **Code Review** +7. **Code Review** Maintainers of the PREP-SHOT project will review your code. They may ask for changes or improvements before the code is merged into the main codebase.