Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.5 KB

Contributing

Reporting Issues / Suggesting new features

If you have found what you think is a bug or want to suggest a new feature, please open an issue.

Development

If you would like to contribute by fixing an open issue or developing a new feature, you can use this suggested workflow:

  • Fork this repository.
  • Create a new feature branch based on the master branch.
  • Install dependencies by running pnpm i.
  • Run the development website by using pnpm run dev:website.
  • Implement your changes and confirm that all test are passing.
  • Commit your changes (see the [committing guidelines]).
  • Submit a PR for review.

Committing

We are applying conventional commits here. In short, that means a commit has to be one of the following types:

  • feat: A new feature.
  • fix: A bug fix.
  • docs: Documentation-only changes.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • test: Adding missing or correcting existing tests.
  • chore: Changes to the build process or auxiliary tools and libraries, such as documentation generation

Pull requests

Please try to keep your pull requests focused and small in scope, and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing! ❤️