Contribution

We welcome and appreciate contributions for the RPEP-SHOT library. Here are the steps to contribute:

Development Process

  1. Create an Issue

    If you find a bug or have an idea for an improvement or new feature, please create an issue.

  2. Fork the Repository

    You can fork the PREP-SHOT repository on GitHub.

  3. Create a Branch

    Create a new branch in your forked repository and name the branch according to the feature or fix you're working on.

  4. Commit Changes

    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. Run Tests To execute all tests, navigate to the root directory of PREP-SHOT and run:

python -m unittest discover -s tests

To check your code for PEP8 compliance, run:

pylint run.py
pylint prepshot

  1. 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.

  2. 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.

Please ensure that you update tests as necessary when you're contributing code, and follow the coding conventions established in the rest of the project.

Building Documentation

The documentation is built using Sphinx. To build the documentation, you need to install the required packages using the following command:

pip install -r docs/requirements.txt

You can build the documentation using the following command:

cd doc
make clean
make html

The documentation will be built in the doc/build directory.

Contributing Guidelines

PREP-SHOT is written in Python and follows the PEP8 coding standard. Please ensure that your code follows the PEP8 coding standard. You can use the Pylint tool to check your code for PEP8 compliance.