Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

New contributor guide

To get an overview of the project, read the documentation. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub

• Set up Git

• GitHub flow

• Collaborating with pull requests

Pull Request Process

Pull Request

When you’re finished with the changes, create a pull request, also known as a PR.

• Fill the “Ready for review” template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.

• Don’t forget to link PR to issue if you are solving one.

• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.

• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.

• As you update your PR and apply changes, mark each conversation as resolved.

• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

• Please make sure that all tests are passing, github pages renders nicely, and code coverage are are not lower than before your contribution. You see the different github action workflows by clicking the “Action” tab in the GitHub repository.