Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

112 lines (78 loc) · 3.21 KB
Raw

Contributing

Thank you for your interest in contributing to installer. We welcome all contributions and greatly appreciate your effort!

Code of Conduct

Everyone interacting in the pip project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

Bugs and Feature Requests

If you have found any bugs or would like to request a new feature, please do check if there is an existing issue already filed for the same, in the project's GitHub issue tracker. If not, please file a new issue.

If you want to help out by fixing bugs, choose an open issue in the issue tracker to work on and claim it by posting a comment saying "I would like to work on this.". Feel free to ask any doubts in the issue thread.

While working on implementing the feature, please go ahead and file a pull request. Filing a pull request early allows for getting feedback as early as possible.

Pull Requests

Pull Requests should be small to facilitate easier review. Keep them self-contained, and limited in scope. Studies have shown that review quality falls off as patch size grows. Sometimes this will result in many small PRs to land a single large feature.

Checklist:

  1. All pull requests must be made against the main branch.
  2. Include tests for any functionality you implement. Any contributions helping improve existing tests are welcome.
  3. Update documentation as necessary and provide documentation for any new functionality.

Development

nox is used to simplify invocation and usage of all the tooling used during development.

Code Convention

This codebase uses the following tools for enforcing a code convention:

  • black for code formatting
  • isort for import sorting
  • mypy for static type checking
  • pre-commit for managing all the linters

To run all the linters:

$ nox -s lint

Testing

This codebase uses pytest as the testing framework and coverage for generating code coverage metrics. We enforce a strict 100% test coverage policy for all code contributions, although code coverage isn't everything.

To run all the tests:

$ nox -s test

nox has been configured to forward any additional arguments it is given to pytest. This enables the use of pytest's rich CLI.

$ # Using file name
$ nox -s test -- tests/*.py
$ # Using markers
$ nox -s test -- -m unit
$ # Using keywords
$ nox -s test -- -k "basic"

Documentation

This codebase uses Sphinx for generating documentation.

To build the documentation:

$ nox -s docs