diff --git a/AUTOMATION.md b/AUTOMATION.md new file mode 100644 index 00000000..b5e8c6b0 --- /dev/null +++ b/AUTOMATION.md @@ -0,0 +1,90 @@ +# Experiment: a semi-automated TypeChat repository + +We are exploring how agents can help maintain TypeChat while keeping community +discussion, clear acceptance criteria, and human accountability at the center +of the project. + +Our goal is to reduce routine coordination and maintenance work so contributors +and maintainers can focus on useful ideas, design decisions, and quality. + +This is an early experiment. The workflow below describes our intended direction; +capabilities will be introduced incrementally, and not everything described here +is available today. + +## Human-guided first + +The initial agent-assisted workflow will require human approval for issue +responses and dispositions, acceptance of proposed work, implementation, +merging, and releases. + +Agents may investigate problems, summarize discussions, suggest questions, write +tests, and propose changes. Automated tests and GitHub Copilot code reviews will +support review, not replace human judgment. + +## From discussion to a reviewed change + +We aim to keep the entire process on GitHub: + +1. **Start with the community.** Use issues for bugs and feature requests, and + Discussions for questions and exploratory conversations. +2. **Clarify the proposal.** Contributors, maintainers, and agents help establish + the intended outcome, scope, non-goals, and testable acceptance criteria. +3. **Accept the work.** A maintainer approves the agreed scope before + implementation begins. Material scope changes return to discussion. +4. **Propose an implementation.** A contributor or agent opens a pull request + linked to the accepted work, with tests and supporting documentation. +5. **Review and accept the result.** Automated checks, GitHub Copilot review, and + human review evaluate the change against its acceptance criteria. Maintainers + approve merging and record the outcome in the original discussion or issue. + +Accepting a proposal is not the same as accepting its implementation. Both +decisions should be clear and visible. + +## Existing issues and contributions + +The experiment will include the existing backlog, not only new submissions. + +We will preserve prior discussions, decisions, and contributor credit; identify +related pull requests; and confirm whether older reports still apply. Existing +contributions should be reviewed and supported rather than duplicated. + +Issues will not be automatically accepted or closed simply because of their age. + +## Longer-term direction + +Eventually, we want suitable community proposals to progress automatically from +discussion to accepted work when they meet clear, publicly documented criteria. +Agents could then help carry that work through implementation and review with +less manual coordination. + +The criteria for automatic adoption will be discussed and published before that +behavior is enabled. Participation, elapsed time, or an agent's recommendation +alone will not guarantee acceptance. + +Ambiguous proposals and higher-impact decisions, including significant API +changes, security-sensitive work, and releases, will continue to involve humans. + +## Gradual rollout + +We plan to: + +- Assess existing issues and related pull requests with maintainer oversight. +- Pilot assisted discussion, clarification, and acceptance. +- Pilot implementation with automated checks, Copilot review, and human approval. +- Evaluate quality and contributor experience before expanding automation. +- Introduce selective autonomy through reviewed, documented policy changes. + +The process should remain understandable, correctable, and easy to pause. + +## Participate + +Continue contributing through issues, Discussions, and pull requests. You do not +need an agent or an AI subscription to participate. Feedback on this experiment +is welcome in GitHub Discussions. + +Our existing [contribution guidance](./README.md#contributing), +[Code of Conduct](./CODE_OF_CONDUCT.md), and [support guidance](./SUPPORT.md) +continue to apply. + +Please follow the [security reporting policy](./SECURITY.md) for vulnerabilities; +do not report sensitive security details in public issues or discussions. diff --git a/README.md b/README.md index 29f4c867..0ac9b3b8 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,13 @@ To learn more about TypeChat, visit the [documentation](https://microsoft.github ## Contributing +**Repository automation experiment:** We are experimenting with a gradual +transition to a semi-automated repository. The initial agent-assisted workflow +keeps humans in the loop, while our longer-term goal is to help community +proposals progress from discussion to accepted, reviewed changes with less +manual coordination. Read about the [automation experiment](./AUTOMATION.md) +and how to participate. + This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.