Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 976 Bytes

File metadata and controls

37 lines (27 loc) · 976 Bytes

Contributing to Athas

Thank you for contributing to Athas! Please check existing issues and pull requests before creating new ones.

Setup

See setup guides for your platform.

Prerequisites:

bun install
bun dev

Before Submitting

  1. Code passes checks: bun check
  2. Auto-fix issues: bun fix
  3. Formatting only when needed: bun format
  4. App runs: bun dev
  5. Run release validation when touching release flow: bun release:check
  6. Rebase on master: git rebase origin/master
  7. Squash commits into logical units
  8. Review and agree to the Contributor License and Feedback Agreement

Guidelines

  • Follow the existing code style
  • Use descriptive commit messages (i.e., "Add autocompletion")
  • One logical change per commit
  • Update documentation if needed