/monorepo
Guides

Contributing

Guidelines for contributing to Monorepo Boilerplate.

We welcome contributions to Monorepo Boilerplate! Please follow these guidelines to ensure a smooth collaboration.

Code Style

  • Commits: We follow the Conventional Commits specification.
    • feat: add user login
    • fix: resolve cors issue
    • docs: update readme
  • Linting: Prettier and ESLint are enforced via pre-commit hooks (husky + lint-staged). Do not bypass them.

Workflow

  1. Fork & Clone: Fork the repo and clone it locally.
  2. Branch: Create a feature branch (git checkout -b feat/my-feature).
  3. Develop: Make your changes.
  4. Test: Ensure tests pass (pnpm test).
  5. Commit: Commit your changes using conventional commits.
  6. Push: Push to your fork.
  7. PR: Open a Pull Request against the develop branch (or main if specified).

Pull Request Guidelines

  • Provide a clear description of what the PR does.
  • Link to any related issues.
  • Ensure CI checks pass.
  • Reviewers will provide feedback; please address it promptly.