Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.76 KB
Raw

Contributing to ktrain

We are happy to accept your contributions to make ktrain better! To avoid unnecessary work, please stick to the following process:

  1. Check if there is already an issue for your concern.
  2. If there is not, open a new one to start a discussion. We hate to close finished PRs.
  3. We would be happy to accept a pull request, if it is decided that your concern requires a code change.

Developing locally

We suggest cloning the repository and then checking out tutorials and examples for information on how to call various methods. Most relevant classes and methods should be documented. If not, you might consider helping to improve the docstrings.

Setup

See the installation instructions for setting things up. Using virtual environment (such as venv and Poetry) is strongly recommended.

Tests

To run all tests, execute:

cd ktrain/tests
python3 -m unittest

To run a specific test (e.g., test_dataloading.py)

python3 test_dataloading.py

PR Guidelines

  • Keep each PR focused. While it's more convenient, please try to avoid combining several unrelated fixes together.
  • Checkout to develop branch before make any changes. Make sure you choose develop branch as base on your PR.
  • Try to maintain backwards compatibility. If this is not possible, please discuss with maintainer(s).
  • Use four spaces for indentation.
  • To ensure a standardized code style, we use the formatter black and isort. If your code is not formatted correctly, it will fail the GitHub Workflow checks when pushed.