Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.08 KB
Raw

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

We Develop with Github

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

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 main.
  2. If you've added code that should be tested, add tests.
  3. If you've added a new feature page, update the documentation. (or mention in the PR that the documentation should be updated)
  4. Make sure you have run prettier to format all code.
  5. Issue that pull request! 🎉

Any contributions you make will be under the GNU LESSER GENERAL PUBLIC LICENSE

In short, when you submit code changes, your submissions are understood to be under the same GNU LESSER GENERAL PUBLIC 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; it's that easy!

Use a Consistent Coding Style

  • Ensure that all of your touched files have been formatted by prettier.
    • If you are using VSCode, ensure you have the prettier extension installed
    • Your files should be formatted on save if you are using VSCode, you can also Open the command pallette and run Format Document
    • If you are using a different editor, ensure that you have manually run prettier to format anything you have modified