Contributing

Axon is a personal project, but contributions are welcome. Before submitting changes, open an issue to discuss the proposed work.

Reporting Issues

Use GitHub Issues to report bugs or request features. Include:

• Axon version.
• Operating system and version.
• Steps to reproduce the issue.
• Expected and actual behavior.
• Screenshots or logs when useful.

Development Environment

Follow Building From Source to set up the backend and Electron app locally.

Coding Standards

• TypeScript uses strict type checking.
• React code uses functional components and hooks.
• Go code follows standard Go conventions.
• TypeScript formatting uses Prettier.
• Go formatting uses gofmt.
• TypeScript linting uses ESLint.
• Go linting should use golangci-lint where configured.

Commit Messages

Use conventional commits:

• feat: for new features.
• fix: for bug fixes.
• docs: for documentation changes.
• style: for code style changes.
• refactor: for code restructuring.
• test: for test changes.
• chore: for maintenance.

Pull Request Flow

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Run tests such as npm test and go test ./... where available.
5. Update documentation if needed.
6. Submit a pull request to main.