Skip to content

Commit ffdeac7

Browse files
committed
Document agentic contribution workflow
1 parent 61139f9 commit ffdeac7

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to FSharp.Stats
2+
3+
FSharp.Stats is primarily maintained through agentic development under human guidance. Maintainers
4+
discuss proposed work and then direct coding agents to make the complete change, including
5+
implementation, tests, documentation, benchmarks, 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, reference implementations, or
11+
links to forks or branches. Maintainers may refine the scope and assign the issue to an agent to
12+
implement and validate the 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, keep it focused, and target the `developer` branch. Maintainers may close
28+
a pull request and use the issue as the basis for an agent-produced implementation instead; the
29+
submitted analysis and code remain valuable inputs to that work.
30+
31+
If a pull request is the agreed approach, follow [AGENTS.md]. Statistical and machine-learning
32+
changes need tests and a canonical reference implementation or an explicit alternative validation
33+
method. Before submission, run:
34+
35+
```bash
36+
./build.sh RunTests
37+
```
38+
39+
[AGENTS.md]: AGENTS.md
40+
[GitHub issues]: https://github.com/fslaborg/FSharp.Stats/issues
41+
[Repo Assist]: https://github.com/githubnext/agentics/blob/main/docs/repo-assist.md

0 commit comments

Comments
 (0)