Skip to content
This repository has been archived by the owner on Jan 9, 2024. It is now read-only.

Latest commit

 

History

History
37 lines (23 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.84 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

We Develop with Github

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

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

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. When writing commit messages, follow conventional commits.
  3. If you've added code, make sure it's covered by tests.
  4. Update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Issue that pull request!

Attribution

This document is adapted from