Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

89 lines (62 loc) · 2.69 KB
Raw

Contributing to pytorch-dp

We want to make contributing to pytorch-dp is as easy and transparent as possible.

Development installation

To get the development installation with all the necessary dependencies for linting, testing, and building the documentation, run the following:

git clone https://github.com/facebookresearch/pytorch-dp.git
cd pytorch-dp
pip install -e .[dev]

Our Development Process

Code Style

pytorch-dp uses the black code formatter to enforce a common code style across the code base. black is installed easily via pip using pip install black, and run locally by calling

black .

from the repository root. No additional configuration should be needed (see the black documentation for advanced usage).

We feel strongly that having a consistent code style is extremely important, so Travis will fail on your PR if it does not adhere to the black formatting style.

Type Hints

pytorch-dp is fully typed using python 3.6+ type hints. We expect any contributions to also use proper type annotations. While we currently do not enforce full consistency of these in our continuous integration test, you should strive to type check your code locally. For this we recommend using pyre.

Unit Tests

To run the unit tests, you can either use pytest (if installed):

pytest -ra

or python's unittest:

python -m unittest

To get coverage reports we recommend using the pytest-cov plugin:

pytest -ra --cov=. --cov-report term-missing

Documentation

At this preview stage, we do not yet have a documentation website. Stay tuned for more!

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you have added code that should be tested, add unit tests. In other words, add unit tests.
  3. If you have changed APIs, document the API change in the PR.
  4. Ensure the test suite passes.
  5. Make sure your code passes both black and flake8 formatting checks.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

License

By contributing to pytorch-dp, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.