From 08f5eb973b4f461d6f9d222494aa54bf578e28b4 Mon Sep 17 00:00:00 2001 From: Don Syme Date: Tue, 25 Aug 2026 01:03:16 +0200 Subject: [PATCH] Document agentic contribution workflow --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fadec9f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to FSharp.Control.AsyncSeq + +FSharp.Control.AsyncSeq is primarily maintained through agentic development under human guidance. +Maintainers discuss proposed work and then direct coding agents to make the complete change, +including implementation, tests, documentation, and other affected files. + +## Start With an Issue + +We generally prefer contributions as [GitHub issues] rather than pull requests. Search for an +existing report first. A useful issue explains the problem or desired outcome, its value, and any +reproduction steps or relevant version details. Proposed changes, patches, and links to forks or +branches are welcome. Maintainers may refine the scope and assign the issue to an agent to implement +and validate the complete change. + +## Repo Assist + +[Repo Assist] is an automated AI assistant that runs regularly in this repository. It may triage or +respond to issues, investigate bugs, suggest improvements, and attempt implementations as draft pull +requests. Its work is identified as automated and remains subject to human review; Repo Assist does +not merge pull requests or make final maintenance decisions. + +Maintainers can invoke Repo Assist with `/repo-assist ` for a specific agentic task, +such as investigating an issue, preparing a fix, adding tests, or updating documentation. + +## Pull Requests + +Every pull request must have a matching issue that has been discussed with the maintainers. Link the +pull request to that issue and keep it focused. Maintainers may close a pull request and use the issue +as the basis for an agent-produced implementation instead; the submitted analysis and code remain +valuable inputs to that work. + +If a pull request is the agreed approach, follow [AGENTS.md], add tests for behavior changes, update +documentation and release notes when applicable, and run: + +```bash +dotnet build FSharp.Control.AsyncSeq.sln +dotnet test FSharp.Control.AsyncSeq.sln +``` + +[AGENTS.md]: AGENTS.md +[GitHub issues]: https://github.com/fsprojects/FSharp.Control.AsyncSeq/issues +[Repo Assist]: https://github.com/githubnext/agentics/blob/main/docs/repo-assist.md \ No newline at end of file