Contributing#

PyKP is an open-source initiative. Contributions are welcome and appreciated.

How to Contribute#

Contributions to the project can be made using the “Fork & Pull” model. The typical steps are:

Create an account on GitHub.
Fork PyKP.
Make a local clone: git clone GITHUB_USERNAME/pykp.git.
Make changes on the local copy.
Test (see below) and commit changes git commit -a -m "my message".
Push to your GitHub account: git push origin.
Create a Pull Request (PR) from your GitHub fork (go to your fork’s webpage and click on “Pull Request.” You can then add a message to describe your proposal).

Otherwise, if you encounter any bugs or have an idea for a new feature but don’t have the time to implement it, please open an issue on the GitHub Issues.

Development Environment#

Fork the Repository: Start by forking the PyKP repository on GitHub.
Clone the Repository: Clone your forked repository to your local machine.
```
git clone https://github.com/yourusername/pykp.git
cd pykp
```

Create a Virtual Environment: Set up a virtual environment to manage dependencies.

python3 -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Install Dependencies: Install the package dependencies in “editable” mode, including development dependencies.
```
pip install --editable .
```
Run Tests: Run the test suite to ensure the setup is working correctly.
```
python -m unittest discover -s tests
```

Writing Tests#

If you make a contribution to the code, please write a test for it. To add a test:

Create a new test file: Place new test files in the tests/ directory, using the naming convention test_<feature>.py.
Use `unittest`: PyKP uses the unittest framework. Use one of the existing tests as a guide.
Run Tests: Run the tests using the command below to ensure everything works as expected.
```
python -m unittest discover -s tests
```