bitzorcas
中 EN

Guide

Contributing guide

How to contribute to BitzOrcas — code style, commit conventions, PR process, and project structure.

Last updated

Thank you for your interest in contributing to BitzOrcas!

Project structure

src/
├── BuildingBlocks/     → Shared infrastructure (10 packages)
├── Platform/            → Business modules (3 projects)
├── Hosts/               → Executable hosts (4 projects)
└── Tooling/             → CLI tools and templates
tests/
├── BitzOrcas.Unit.Tests
├── BitzOrcas.Application.Tests
├── BitzOrcas.Integration.Tests
├── BitzOrcas.Architecture.Tests
└── BitzOrcas.CodeGeneration.Tests

Code style

  • Language: C# with nullable reference types enabled
  • Naming: PascalCase for public members, _camelCase for private fields
  • Comments: Chinese comments in source code (团队约定)
  • AOT awareness: No reflection in AOT-enabled projects (API Host)

Commit conventions

  • Use conventional commits: feat:, fix:, docs:, refactor:, test:
  • Reference issue numbers where applicable

PR process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run dotnet build and dotnet test
  5. Submit a pull request

Module creation checklist

When adding a new module:

  • Entity in Infrastructure.Persistence.Models
  • Service port in Platform.Application
  • InMemory/Null defaults in Platform.Application
  • SqlSugar repository in Infrastructure.SqlSugar
  • Integration event DTOs in SaaS.Contracts
  • Minimal API endpoints in Api/Endpoints
  • DI registration in PersistenceRegistration
  • Architecture test for module boundaries

See also