|
| 1 | +# Contributing to FSharp.Control.TaskSeq |
| 2 | + |
| 3 | +FSharp.Control.TaskSeq is primarily maintained through agentic development under human guidance. |
| 4 | +Maintainers discuss proposed work and then direct coding agents to make the complete change, |
| 5 | +including implementation, tests, documentation, and other affected files. |
| 6 | + |
| 7 | +## Start With an Issue |
| 8 | + |
| 9 | +We generally prefer contributions as [GitHub issues] rather than pull requests. Search for an |
| 10 | +existing report first. Issues may include proposed changes, patches, or links to forks or branches. |
| 11 | +Maintainers may refine the scope and assign the issue to an agent to implement and validate the |
| 12 | +complete change. |
| 13 | + |
| 14 | +## Repo Assist |
| 15 | + |
| 16 | +[Repo Assist] is an automated AI assistant that runs regularly in this repository. It may triage or |
| 17 | +respond to issues, investigate bugs, suggest improvements, and attempt implementations as draft pull |
| 18 | +requests. Its work is identified as automated and remains subject to human review; Repo Assist does |
| 19 | +not merge pull requests or make final maintenance decisions. |
| 20 | + |
| 21 | +Maintainers can invoke Repo Assist with `/repo-assist <instructions>` for a specific agentic task, |
| 22 | +such as investigating an issue, preparing a fix, adding tests, or updating documentation. |
| 23 | + |
| 24 | +## Pull Requests |
| 25 | + |
| 26 | +Every pull request must have a matching issue that has been discussed with the maintainers. Link the |
| 27 | +pull request to that issue and keep it focused. Maintainers may close a pull request and use the issue |
| 28 | +as the basis for an agent-produced implementation instead; the submitted analysis and code remain |
| 29 | +valuable inputs to that work. |
| 30 | + |
| 31 | +If a pull request is the agreed approach, follow [AGENTS.md], add tests and an `Unreleased` entry in |
| 32 | +`release-notes.txt` for user-visible changes, and run: |
| 33 | + |
| 34 | +```bash |
| 35 | +dotnet tool restore |
| 36 | +dotnet fantomas . --check |
| 37 | +dotnet build src/FSharp.Control.TaskSeq.sln -c Release |
| 38 | +dotnet test src/FSharp.Control.TaskSeq.Test/FSharp.Control.TaskSeq.Test.fsproj -c Release |
| 39 | +``` |
| 40 | + |
| 41 | +[AGENTS.md]: AGENTS.md |
| 42 | +[GitHub issues]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues |
| 43 | +[Repo Assist]: https://github.com/githubnext/agentics/blob/main/docs/repo-assist.md |
0 commit comments