Contribution Guide

We appreciate open-source contributions! And if you would like to contribute but are not sure where to start, take a look at our issues, Roadmap, or Discussions. If you would like to run an idea by us, feel free to open a Feature Request.

Issues marked with help wanted are a good place to look for features we would like help with!

Steps

Once you have your idea, follow the steps below to ensure your feature gets into the main branch:

• Fork our repo and make changes
• Pre-Pull Request
  • Confirm Tests
    • Write/update unit tests in tests/
    • Run Pytest from root directory: pytest
      • Should all pass
  • Confirm Code Style
    • Run Pylint from root directory: pylint --rcfile=.pylintrc torchsig
      • Score must be > 9/10
• Make a Pull Request
  • Give us some time to review it
• Merge into main, nice!

Resources

PEP 8 Python Style Guide

Google-style Docstrings

Pytest Docs

Pytest-Cov Docs

Pylint Docs