kolatz/umbr_api

# Contributing to this repo

## Communications

Thank you for interest to this repository. Please use GitHub issues to
discuss topics below before making any changes:

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

## Submitting pull requests

This repo is created mostly for education purposes. No guarantees that
your pull requests will be accepted, sorry about that. But, feel free
to clone the repo and do whatever you want.

To submit 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 fully lints including optional linters.
6. Issue that pull request.

## Report bugs using GitHub's [issues](https://github.com/kolatz/umbr_api/issues)

We use GitHub issues to track public bugs. Report a bug by
[opening a new issue](https://github.com/kolatz/umbr_api/issues/new).

### 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 Formatting Style

We honor `black` to automatically format all Python code. Please use it to
maintain a consistent formatting style.

## License

By contributing, you agree that your contributions will be licensed under
it's [MIT License](http://choosealicense.com/licenses/mit/). Feel free
to open an issue if that's a concern.

## References

This document was adapted from the open-source contribution guidelines for
[Facebook's Draft.js](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)