Skip to content

Latest commit

 

History

History
41 lines (22 loc) · 1.8 KB

File metadata and controls

41 lines (22 loc) · 1.8 KB

Contributing to {{PROJECT_NAME}}

First off, thank you for your interest in contributing! We're excited you're here.

Development Philosophy

This project adheres to the principles documented in meta/DEVELOPMENT_PHILOSOPHY.md. Please read and understand these principles before contributing.

Development Workflow

This project follows an AI-assisted development workflow:

  1. An Issue is created that clearly defines a bug or a feature.
  2. An AI assistant (like GitHub Copilot) is used to generate the code to address the issue, resulting in a Pull Request.
  3. The PR is then reviewed, tested, and merged by a human maintainer.

How You Can Help

🐛 Report Bugs or Suggest Features

If you find a bug, have an idea for a feature, or think something could be improved, please open an issue! Clear issues are the starting point for the entire workflow.

💬 Provide Feedback

Have thoughts on the project's direction, architecture, or process? Feel free to open an issue to start a discussion.

📖 Improve Documentation

If you find a typo, feel something is unclear, or have a question that could be answered in the docs, please let us know by opening an issue.

Code Contributions

For now, code generation and merging is handled through the AI-assisted workflow described above. As the project matures, this process will likely evolve.

Architecture Decision Records

When making significant decisions, we use Architecture Decision Records (ADRs). Please review existing ADRs before proposing changes that may conflict with accepted decisions.

Code of Conduct

All participants are expected to follow our Code of Conduct. Please be respectful and considerate in all your interactions.