Skip to main content

Contributing guide

Guide for developers who want to contribute to Bot Ban Hang documentation and codebase.

Contribution workflow​

  1. Fork the repo to your personal account
  2. Create a new branch from main — name it feature/<feature-name> or fix/<bug-description>
  3. Code following the team's Code conventions
  4. Create a Pull Request with a clear description of changes
  5. Wait for review and merge

Documentation rules​

  • Write in Vietnamese, keep technical terms in English
  • Each module/service has its own file
  • Page structure: Description → API Endpoints → Request/Response → Examples
  • Use code blocks with syntax highlighting

Docs environment setup​

cd vn.merchant.docs
pnpm install
pnpm dev

Docs runs at http://localhost:3000.

Contents