Thanks for your interest in contributing! This document covers the essentials.
See the README for instructions on setting up the development environment.
- Search existing issues before opening a new one.
- Use the appropriate issue template (bug report or feature request).
- Provide as much detail as possible, including steps to reproduce for bugs.
- Fork the repository and create a branch from
main. - Make your changes in a focused, single-purpose branch.
- Ensure your code passes linting and any existing tests.
- Fill out the pull request template when submitting.
- Keep pull requests small and reviewable when possible.
This project includes an ESLint configuration (eslint.config.mjs). Run the linter before submitting:
npm run lintFollow the existing code patterns and conventions you see in the codebase.
This project follows Conventional Commits. Format your commit messages as:
<type>(<optional scope>): <description>
[optional body]
Common types:
feat-- a new featurefix-- a bug fixdocs-- documentation changesstyle-- formatting, no code changerefactor-- code restructuring without behavior changetest-- adding or updating testschore-- maintenance tasks
Examples:
feat(api): add webhook retry endpoint
fix(ui): correct timestamp display in request list
docs: update setup instructions in README
This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.