Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 <instructions>` 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
Loading