Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

78 lines (51 loc) · 2.98 KB

Contributing to pyCheckpoint-API

I'd love your input! I 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

I Develop with Github

I use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

I use GitFlow for releases, so all code changes happen through pull requests in the 'develop' branch

Pull requests are the best way to propose changes to the codebase. Pull requests are welcome:

  1. Fork the repo and create your branch from develop.
  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!

Once your change has been merged into develop, it will be bundled with the next batch of changes into the next release, which is merged into main.

Keep Pull Requests Short and Specific

It takes a lot of work to review a PR that covers multiple issues or features. Breaking your PR up into smaller requests is greatly appreciated. Doing this ensures quick review and PRs that require additional work won't hold up other work.

If there is one thing you do, please do this.

I recommend Conventional Commits

No system is perfect, but I've found Conventional Commits to work pretty well for myself. At the very least check it out and see if it works for you too.

Any contributions you make will be under the MIT Software License

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

Report bugs using Github's issues

I 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.

Use a Consistent Coding Style

  • Black is used for formatting in this project with line-length 127.
  • Flake8 is used for linting.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

References

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