Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 2.16 KB

Contributing to novaposhta-api-client

Thank you! Contributing to this project can make other's developers life easier by doing following:

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

Developed with Github

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

Let's Try To Use GitHub Flow

Pull requests are appreciated. 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. Please, use black and mypy
  7. Issue that pull request!

Any contributions you make will be under the Software License

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

Report bugs using Github's 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)

Use a Consistent Coding Style

License

By contributing, you agree that your contributions will be licensed under its LICENSE.