Skip to main content

Contribution guide

Welcome! We are glad that you want to contribute to our project 💖

There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the template itself.

This document outlines the process to help get your contribution accepted.

Thanks to everyone who has contributed!

Ground Rules​

A few general guidelines:

  • For major changes, please open an issue first to discuss what you would like to change.
  • Contributors should fork the repository and work on fixes or enhancements on their own fork.
    • Use the pull request feature to submit your changes to this repository.
    • Please do not commit directly to main.
    • All pull requests should be rebased (with main) and commits squashed prior to the final merge process.
    • Use conventional commit formatting for commit messages, so that it's possible to auto-generate the changelogs.
    • Do not combine fixes for multiple issues into one branch. Use a separate branch for each issue you’re working on.
  • Please include unit tests with all your code changes.
    • All unit tests must be 100% passing before the pull requests will be approved and merged.

How to report a bug​

Report something that is broken or not working as intended here.

How to suggest a feature or enhancement​

Ideas for a new feature or enhancement are always welcome.

For new features, please open an issue first to discuss what you would like to add here.

For enhancements please open an issue first to discuss what you would like to change here.

Write documentation​

This site was generated from the contents of your docs folder using https://docusaurus.io/ and we host it on GitHub Pages.

Documentation is important for users to understand the program and its features. The documentation is written in markdown, a simple markup language. It can be found in the docs folder.

To start, please install (yarn).

Get started by running:

cd docs
yarn install
yarn start

All stable documentation can be found in the versioned_docs folder.

Fork the project and create a pull request to add your documentation to the main branch.

Getting started coding​

If you’d like to work on a pull request and you’ve never submitted code before, follow these steps:

  1. Set up a local development environment.
    1. Please refer to the manual for instructions on how to build, test, and run the template locally.
  2. If you want to implement a breaking change or a change to the core, ensure there’s an issue that describes what you’re doing and the issue has been accepted. You can create a new issue or just indicate you’re working on an existing issue.
    1. Bug fixes, documentation changes, and other pull requests do not require an issue up-front.

After that, you’re ready working with code.