Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

75 lines (57 loc) · 2.68 KB
Raw

About

Thank you for taking the time to contribute to this repository!

When contributing, 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.

Code of Conduct

This project and everyone that participates in it are governed by the Code of Conduct. By participating, you are expected to uphold this code.

Bug Reports, Feature Requests and Enhancements

You've found a bug in the source code, a mistake in the documentation, or maybe you'd like a new feature or enhancement? Take a look at the discussions to see if it's already being discussed, or you can help us by submitting an issue.

Developers Guide

Please follow the Developers Guide to set up your development environment.

Submitting a PR

  1. Fork the project
    1. Sign in to your GitHub account or create a new one
    2. Fork the main repository
    3. Sync your fork with the original repository
  2. Create your branch (git checkout -b my-amazing-feature). We use kebab-case for branch names, and only lowercase alphabetical characters, numbers, dots and dashes are allowed.
  3. Implement your changes
    1. Make sure your changes follow the style of the project
    2. Add or modify tests where necessary
    3. Update documentation where necessary
  4. Lint your changes and run the tests.
  5. Commit your changes (git commit -m 'feat: add an amazing feature'). We use the Conventional Commitsspecification for the commit messages.
  6. Push to your branch (git push origin my-amazing-feature)
  7. Open a PR. We use the Conventional Commits specification for the PR title.