Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.65 KB

Contributing

Welcome! Thanks for your interest in helping to make the project better. Before making a contribution, please read through this document fully to be aware of what is expected. If you have any questions, please feel free to open an issue, or reach out to the community on Discord.

Contributions to this project are released to the public under the project's open source license. By participating in this project you agree to abide by its terms, and agree to donate your contributions to the project.

All contributors and community members should always be polite, courteous, and helpful. Please help to keep our community to be a welcoming one!

Ways to contribute

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

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

Please reach out if you have any questions.

Code Contributions (Pull Requests)

If you have any substantial changes that you would like to make, please open an issue so we can discuss it and avoid any wasted efforts.

  1. Fork and clone the repository
  2. Install Node.js
  3. Install needed dev dependencies: npm install
  4. Create a new branch: git checkout -b my-branch-name
  5. Run tests and make sure they are all passing: npm run test
  6. Make your changes, add tests (if applicable)
  7. Run tests again to make sure they still pass
  8. Push to your fork and submit a pull request
  9. Wait for your pull request to be reviewed, and be willing to answer questions or make adjustments as needed so that it can get merged

Tips for a good review process:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write tests if possible
  • Write a good commit message. This project is aiming to use gitmoji. For examples, look through the commit history.
  • If you are adding a new feature, please include a section in the pull request with proposed text to be included in the main wiki page.

Releases

Releases are controlled by project maintainers and don't have a set schedule. Releases often happen when a milestone is reached, a new feature is ready to go, or a bug has been fixed.