CONTRIBUTING.md

How to contribute

It's great you're here and reading this guide, because we need volunteers to help keep this project active and alive for the greater benefit of everyone!

• Engaging with this project
  • Coding Conventions
• Documentation
• Submitting Contributions

Engaging with this project

TODO: Add links below to your repo's GitHub Issues and Discussions pages.

Here are some important resources:

• GitHub Issues - a place for bugs to be raised and feature requests made
• GitHub Discussions) - a place to discuss ideas or real-world usage

Coding Conventions

• In order to help verify the authenticity of contributed code, we ask that your commits be signed. All commits must be signed off to show that you agree to publish your changes under the current terms and licenses of the project.

  Here are some notes we found helpful in configuring a local environment to automatically sign git commits:

  • GPG commit signature verification
  • Telling Git about your GPG key

Documentation

Documentation is generated using action-docs.

First install using:

npm install -g action-docs

Documentation can then be generated by running:

action-docs --update-readme

Submitting Contributions

Please send Pull Requests that:

1. Have a singluar purpose, and that is backed by one or more GitHub Issues in this project
2. Are clear
3. Have appropriate test coverage for the Pull Requests purpose
4. Meet our Code Style Convention (see above)