Skip to content
This repository has been archived by the owner on Dec 4, 2023. It is now read-only.

Latest commit

 

History

History
40 lines (31 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

40 lines (31 loc) · 1.67 KB
Raw

Contributing to ptr

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

All development is done in GitHub and releases are sent to PyPI:

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes - You can run ptr on itself. Consult ci.py and our TravisCI config to see how the test suite works.
  5. Make sure your code lints (ptr will enforce black + mypy).
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

Complete your CLA here: https://code.facebook.com/cla

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.

Coding Style

  • 4 spaces for indentation rather than tabs
  • Around 88 character line length
  • We use black, so please blacken all your code before submitting.

License

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