Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (34 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

56 lines (34 loc) · 1.58 KB
Raw

Contributing to the Oqtane AI Playbook

Thank you for your interest in improving the Oqtane AI Playbook. The playbook is intended to be a living document, and community feedback is essential to keep it accurate and relevant as AI development practices evolve.

Ways to Contribute

You can contribute in several ways:

1. Report an Issue

If you find an error, outdated guidance, or unclear documentation:

  1. Open a GitHub Issue
  2. Describe the problem clearly
  3. Suggest a correction if possible

2. Suggest an Improvement

If you have an idea for improving the playbook:

  1. Open a GitHub Issue
  2. Explain the proposed improvement
  3. Discuss it with the community before implementation

3. Submit a Pull Request

For direct improvements to the documentation:

  1. Fork the repository or create a feature branch
  2. Make your changes
  3. Submit a Pull Request to the develop branch

All changes are reviewed before being merged to ensure they align with the governance principles of the playbook.

Governance Alignment

Changes should respect the governance structure described in the playbook, including:

  • Architectural consistency
  • Clear documentation
  • Traceable decisions
  • Maintainability

Update Process

The playbook evolves through the following workflow:

Issue → Discussion → Pull Request → Review → Merge → Release

Updates are merged into the develop branch and periodically released to main.

Thank You

Your contributions help ensure the Oqtane AI Playbook remains a practical and reliable guide for governed AI-assisted development.