Thank you for considering contributing to this project. These guidelines help keep things organized and consistent.
- Check existing issues first to avoid duplicates.
- Open a new issue with a clear title, detailed description, and as much relevant information as possible.
- Open a new issue with a clear title and detailed description.
- Explain why the enhancement would be useful.
- Fork the repository and create your branch from
main. - Follow the documentation standards in
docs/documentation-standards/. - Include YAML frontmatter on any new Markdown files (see
docs/documentation-standards/tagging-strategy.md). - Add interior READMEs to any new directories.
- Use the appropriate script header template for new scripts.
- Write clear commit messages (present tense, imperative mood, 72-char first line).
- Update relevant documentation if your change affects it.
- Submit your pull request with a clear description of the changes.
This project uses RAG-optimized documentation with YAML frontmatter. Before contributing documentation, review:
- Tagging Strategy — controlled vocabulary for tags
- Code Commenting — dual-audience commenting for humans and AI agents
- Template selection guide in Documentation Standards README
- Follow existing patterns — match the style of surrounding files
- Keep documentation lean — don't pad sections for completeness
- Use semantic numbering and preserve gaps if sections are omitted
Open an issue with your question, or reach out via the contact information in SECURITY.md.