Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (35 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 1.58 KB

Contributing to Archon

Thank you for your interest in contributing to Archon! This project is built agentically by a coordinated swarm of AI agents, but human contributors are welcome and encouraged.

How to Contribute

Reporting Issues

  • Use GitHub Issues for bug reports, feature requests, and questions
  • Include reproduction steps, expected vs. actual behavior, and environment details
  • Tag issues with appropriate labels (bug, enhancement, documentation, etc.)

Code Contributions

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes following our coding standards
  4. Write tests for new functionality
  5. Ensure all existing tests pass
  6. Submit a Pull Request with a clear description

Coding Standards

  • Python: Follow PEP 8, use type hints, format with Black + isort
  • TypeScript: Strict mode, ESLint + Prettier
  • Documentation: Every public API must have docstrings and OpenAPI spec
  • Tests: Minimum 80% coverage for new code

Commit Messages

Follow conventional commits:

feat: add template search API
fix: resolve WebSocket reconnection issue
docs: update deployment guide for air-gapped environments
test: add integration tests for DLP pipeline

Code of Conduct

We are committed to providing a welcoming and inclusive experience. All participants are expected to:

  • Be respectful and considerate
  • Welcome diverse viewpoints
  • Accept constructive criticism gracefully
  • Focus on what is best for the community

License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.