Skip to main content

​
Contributing

This section is the public entrypoint for contributors who want to understand how Loong expects work to be shaped, validated, and reviewed. This page stays short on purpose. Use the repository’s CONTRIBUTING.md when you need the deeper repository-native single-file guide, crate-level recipes, and maintainer-adjacent contribution guidance.

​
Choose A Contribution Lane

If you want to…Start hereThen continue to…
land a small docs, test, or contained bug-fix patchContribution WorkflowContribution Areas and CONTRIBUTING.md
improve docs placement, Mintlify structure, or public docs wordingDocs WorkflowDocumentation Policy and Contribution Workflow
change runtime behavior, policy, or architecture-sensitive codeArchitectureContribution Workflow and CONTRIBUTING.md
understand where your background is most useful firstContribution AreasContribution Workflow
read the repository-native recipes and rules directlyCONTRIBUTING.mdthe supporting public references under docs/

​
Public Start Here

Start with:

​
What Those References Cover

Together they describe:
  • the branch and release model
  • CI and validation expectations
  • where docs changes belong across README, site/, and docs/
  • the Mintlify docs validation and deployment shape
  • contribution tracks
  • the areas where design, docs, QA, and systems work are especially valuable
  • the public docs language scope
  • where to go next for deeper repo-native recipes

​
Contribution Shape

TrackGood fit
Track Adocs, tests, contained bug fixes, small refactors
Track Bsecurity-sensitive behavior, API contract changes, runtime or kernel policy changes, architecture-impacting refactors

​
What To Expect

  • Loong treats public architecture boundaries seriously.
  • Reader-facing docs, tests, and verification are part of a complete contribution, not afterthoughts.
  • Internal planning history no longer drives public navigation, so contributors should anchor on the current public contract rather than old repo archaeology.
  • The docs site should answer common contributor questions directly instead of making every reader dig through repository markdown first.

​
Documentation Scope Reminder

  • The repository keeps Simplified Chinese support only for README.zh-CN.md.
  • The public docs site under site/ is the main reader-facing docs surface.
  • Repository markdown under docs/ remains public as supporting reference and source-facing material.
  • If wider docs i18n is added later, it should happen at the docs-site layer rather than by expanding repository-wide markdown translations.

​
Deep References