Skip to main content

Contributing

Contributions are welcome! Please read this guide before submitting a PR.

Setupโ€‹

git clone https://github.com/NguyenTriBaoThang/AirSafeNet.git
cd AirSafeNet
cp .env.example .env
docker compose up -d

Branch Strategyโ€‹

BranchPurpose
mainStable, demo-ready
developActive integration
feature/*New features
fix/*Bug fixes
docs/*Documentation

Commit Conventionโ€‹

feat:     New feature
fix: Bug fix
docs: Documentation
style: CSS / formatting
refactor: Code refactor
test: Tests
chore: Build / config
ai: AI model changes

Pull Request Checklistโ€‹

  • Code builds successfully
  • No secrets committed
  • TypeScript / lint passes
  • Documentation updated if needed

Reporting Issuesโ€‹

Use GitHub Issues with the bug or feature template.