Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.83 KB

Contributing

We love your input! We 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

We use [Github Flow][1]

Merge(pull) requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Clone the repo(do not fork) and create your branch from main.
  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. Issue that pull request!

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

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)

People love thorough bug reports.

Use a consistent coding style

  • Adhear to the .editorconfig rules, if your IDE doesn't support it, use the file to adjust your coding style
  • Indent size: 2 spaces
  • Tab Character: space
  • New Line at File End: Yes

License

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