Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 2.6 KB
Raw

Contributing

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We develop with Github

We use Github to host code, to track issues and feature requests, as well as accepting pull requests.

Pull requests are the best way to propose changes to the codebase (we use Github Flow). 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.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the Apache Software License

In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github Issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

We aim to follow PEP 8 recommendations in this project, with a max. line width of 100 characters. Source code documentation relies on restructured text, so that we can generate pretty API docs with Sphinx.

You may use flake8 to check for common style issues:

flake8 src --max-complexity=10 --max-line-length=100 --ignore=F401,W504

But please be aware that a consistent code style can only be achieved by reading and understanding code; tools like linters are useful, but they can never confirm that everything is ok.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.