Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.43 KB

Contributing to Documentation

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

  • Reporting a typo
  • Discussing the current state of the documentation
  • Suggestions on improvements
  • Becoming a maintainer

We develop with Github

We use Github to host the documentation, track issues, and accept pull requests.

All documentation changes happen through pull requests

Pull requests are the best way to propose changes to the documentation. We actively welcome your pull requests:

Any contributions you make will be under the MIT License

In short, when you submit documentation 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 typos or suggestions using Github's issues

We use GitHub issues to track typos and suggestions on how to improve the documentation. Report a typo or suggestion by opening a new issue; it's that easy!

We use MkDocs

Please, read Material for MkDocs before you contribute.

License

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