Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.89 KB
Raw

Contributing to the Open Source Red Flag Checker

Thank you for your interest in our project. Contributions are welcome. Feel free to open an issue with questions or reporting ideas and bugs, or open pull requests to contribute code.

We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!

Development setup

Starting development is as easy as installing poetry and running poetry install once.

In order to run the project in the new virtual environment, run poetry run ossrfc.

Typical contributions

Add a new check

See commit cc93fc8b07445e09b5b92de207632d86edc0125d or a51d145b4837f09809752765112ea3782b9d1ab6 as an example:

  1. _licensing.py (or another file that the new check relates to)
    • Add a new function for the check
  2. _report.py
    • Add new attributes to the RepoReport dataclass if needed
  3. _analysis.py
    • Add a new evaluation function in which you rate the finding
    • Apply the function in analyse_report()
  4. checker.py
    • Add an ID for the check in the choices for the --disable and --ignore flags
    • Add the new check function in check_repo()
  5. README.md
    • Add the new searched data point under the "Searched data" headline
    • Add its analysis under the "Analysis based on data" headline

Release workflow

  • Upgrade dependencies: poetry update
  • Bump version in pyproject.toml
  • Build package: poetry build
  • Optional: publish to test.pypi.org with poetry publish -r test-pypi and test the package: pip install -i https://test.pypi.org/simple oss-red-flag-checker
  • Publish to PyPI: poetry publish (you may have to set your credentials/API key first)
  • Create Git tag: git tag -s vx.y.z (use a minimal message)
  • Push to GitHub: git push && git push --tags
  • Make a release on GitHub