Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.46 KB

Contributing

Thank you for your interest in contributing to the project!

To get up and running, follow these steps:

  1. Clone the repository
  2. Install dependencies: pnpm install
  3. Build everything pnpm run build
  4. Run tests: pnpm run test
  5. Run end to end tests using Playwright: 
    pnpm run test:e2e # add `-- -- --debug` to step through the tests
  6. Test search manually: pnpm run serve

You can view debug information at http://localhost:3000/\_\_docusaurus/debug (generated by @docusaurus/plugin-debug)

Commit Message Guidelines

Commit messages for this repository should follow the "Conventional Commits" specification. Each message must start with one of the following keywords:

build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Include a brief description after the keyword, starting with a capital letter and no ending period. For example:

fix: Add German translation
feat: Add better search integration
chore: Update dependencies
docs: Added more detailed documentation

Please use feat for new features, fix for bug fixes, or one of the other keywords when appropriate.

To mark breaking changes, include a ! after the keyword. For example:

chore!: Require Node.js v16

By following these guidelines, we can ensure that our commit messages are clear and consistent, which makes it easier to automatically generate changelogs.