diff --git a/.mise.toml b/.mise.toml new file mode 100644 index 0000000..d033e51 --- /dev/null +++ b/.mise.toml @@ -0,0 +1,2 @@ +[tools] +just = "1.36.0" diff --git a/.tool-versions b/.tool-versions deleted file mode 100644 index 185ff65..0000000 --- a/.tool-versions +++ /dev/null @@ -1 +0,0 @@ -just 1.36.0 diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 0000000..607e3d8 --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,47 @@ +# Architecture + +## Overview + +This repository follows a modular, maintainable architecture designed for clarity, scalability, and long-term sustainability. + +## Directory Structure + +``` +. +├── src/ # Source code +├── tests/ # Test suites +├── docs/ # Documentation +├── scripts/ # Utility scripts +├── config/ # Configuration files +├── LICENSE # License file +├── LICENSES/ # Full license texts +└── README.adoc # Project documentation +``` + +## Design Principles + +- **Separation of Concerns**: Each module has a single responsibility +- **Testability**: Code is written to be easily testable +- **Documentation**: All public APIs are documented +- **Configuration**: Environment-specific settings are externalized + +## Dependencies + +- External dependencies are minimized and clearly declared +- Version pinning is used for reproducibility + +## Security Considerations + +- Sensitive data is never committed to the repository +- Secrets are managed through environment variables or secure vaults +- Regular dependency audits are performed + +## Maintainability + +- Code follows consistent style guidelines +- Pull requests require review and CI checks +- Issues and discussions are tracked transparently + +--- + +*Last updated: 2026-07-18* diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..e27364c --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,60 @@ +# Governance + +## Overview + +This project is governed by the following principles and structures to ensure transparent, inclusive, and effective decision-making. + +## Roles and Responsibilities + +### Maintainers + +Maintainers are responsible for: +- Reviewing and merging pull requests +- Managing releases and versioning +- Ensuring code quality and standards +- Triaging issues and bug reports +- Community engagement and support + +### Contributors + +Contributors are expected to: +- Follow the code of conduct +- Submit well-documented pull requests +- Write tests for new functionality +- Maintain existing tests +- Update documentation as needed + +## Decision Making + +### Minor Changes +- Can be made by any maintainer +- Include bug fixes, documentation updates, dependency updates + +### Major Changes +- Require discussion in issues or pull requests +- Include new features, architectural changes, API changes +- Need approval from at least 2 maintainers + +### Breaking Changes +- Require RFC (Request for Comments) process +- Need approval from majority of maintainers +- Must include migration guide + +## Code of Conduct + +All participants are expected to follow our Code of Conduct. Violations can be reported to the maintainers. + +## Communication + +- **Issues**: For bug reports and feature requests +- **Discussions**: For questions and general discussion +- **Pull Requests**: For code contributions + +## Licensing + +All contributions are made under the terms of the repository's LICENSE file. +By submitting a pull request, you agree to license your contributions accordingly. + +--- + +*Last updated: 2026-07-18*