Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.74 KB
Raw

Contributing to the project

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

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

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

Pull requests are the best way to propose changes to the codebase (Github Flow). Your pull requests are welcome:

  1. Fork the repo and create your branch from main;
  2. If you have added code that should be tested, add tests;
  3. If you have changed APIs, update the documentation;
  4. Ensure tests are passing;
  5. Make sure your code lints;
  6. Issue that pull request!

Any contributions you make will be under the MIT 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

GitHub issues are used to track public bugs. Report a bug by opening a new issue.

Use a Consistent Coding Style

  • 2 spaces for indentation rather than tabs;
  • 80 character line length;

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft