Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.42 KB
Raw

How to contribute

Design policy

The design policy of pip-licenses is as follows.

  • Focus only on outputting license information of Python packages installed in user's environment.
  • Support Python 3.5 or later.
  • External packages that depend on runtime are PTable only.
    • Expect that pip and setuptools are implicitly installed.

Setup

  1. Fork this repository on your GitHub account.
  2. Create a branch to represent changes.
    • Branch name does NOT need feature/ prefix. Because git-flow is too complicated.
  3. Create a new venv environment.
  4. Install package for development via make setup .
    • Dependencies are managed by pip-tools.
    • If you want to add dependency packages for development, edit dev-requirements.in file and run make update-depends .
    • When you want to install the code under development, run make local-install .

Implementation and testing

  • Code conventions follow the PEP 8.
  • pip-licenses always measures code coverage for code quality. If you implement the new feature, please also write unit test in test_piplicenses.py.
    • Tests can be run with make test .
  • Send pull request to master branch.