Skip to content

Contributing

Thank you for your interest in contributing to Labitat!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/labitat.git
  3. Install dependencies: pnpm install
  4. Start development server: pnpm dev
  5. Create a branch: git checkout -b feature/your-feature

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on what's best for the community

Commit Conventions

We use Conventional Commits:

feat: add new feature
fix: fix a bug
docs: update documentation
style: formatting changes
refactor: code refactoring
test: add tests
chore: maintenance tasks

Breaking changes:

feat!: breaking change description

BREAKING CHANGE: description of the breaking change

The version is automatically bumped based on commit type:

  • feat → minor version bump
  • fix → patch version bump
  • BREAKING CHANGE → major version bump

Pull Request Process

  1. Update documentation if needed
  2. Test your changes thoroughly
  3. Ensure all checks pass (pnpm lint && pnpm typecheck && pnpm build)
  4. Create a PR with a clear description
  5. Wait for review

Questions?

  • Open an issue for bugs or feature requests
  • Join discussions in existing issues

Released under the MIT License.