Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

19 lines (13 loc) · 1.25 KB

Contributing

Issues

When submitting an issue report, please make sure to fill up the details as specified in the issue template.

This is a strict requirement, and failure to do so will get your issue closed without response.

Pull Requests

Here are a few simple guidelines to follow if you wish to submit a pull request:

  • Submit an Issue (mark as "Other") describing what you intend to implement. Allow me time to provide feedback so that there is less risk of rework or rejection.
  • New endpoints should be accompanied by a relevant test case.
  • Backward compatibility should not be broken without very good reason.
  • I try to maintain a small dependency footprint. If you intend to add a new dependency, make sure that there is a strong case for it.
  • Run flake8 --max-line-length=120 on your changes before pushing.
  • Please do not take a rejection of a PR personally. I appreciate for your contribution but I reserve the right to be the final arbiter for any changes. You're free to fork my work and tailor it for your needs, it's fine!

Thank you for your interest.