Skip to main content

Contribution Guide

Purpose​

This guide outlines the technical workflow required to download, modify, test, and submit contributions to Chambey repositories.

Summary​

Chambey codebases are hosted on GitHub. Contributors fork the project, create feature branches, commit updates, run verification test suites, and submit pull requests for review by core maintainers.

Who This Is For​

  • Developers & Web Engineers: Writing front-end components, back-end APIs, or database scripts.
  • Technical Writers: Editing configuration files or styling templates.

Key Details​

  • Forking Rule: Never commit directly to the main branch. Always fork and work on a feature branch (e.g., feature/custom-card-hover).
  • Commit Style: Use semantic commit messages (e.g., feat: add hover animations to cards or fix: resolve responsive grid breaking).
  • Testing: Run local tests (e.g., npm run test, npm run typecheck) prior to committing. Unchecked test builds will fail CI checks.

Next Steps​