From fb7cdda00a12bba46efacce319ccf9396abeb9aa Mon Sep 17 00:00:00 2001 From: Don Syme Date: Tue, 25 Aug 2026 01:03:24 +0200 Subject: [PATCH] Document agentic contribution workflow --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49c41a20..9065a019 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,35 @@ -# Contribution guidelines +# Contributing to FSharp.Data.SqlClient -Contributions to this repository are welcome, you can engage with users and contributors [on Gitter https://gitter.im/fsprojects/FSharp.Data.SqlClient](https://gitter.im/fsprojects/FSharp.Data.SqlClient) chat room. +FSharp.Data.SqlClient 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, samples, and other affected files. -## Code and documentation contributions: +## Start With an Issue -There is very low bar for submitting a PR for review and discussion, changes to code that will get merged will generally requires a bit of back and forth beyond simplest fixes. +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. + +## Code and Documentation Contributions ### Contributing to the docs @@ -13,3 +38,6 @@ The best way is to pull the repository and build it, then you can use those FAKE * **GenerateDocs** : Will run FSharp.Formatting over the ./docs/contents folder. * **ServeDocs** : Will run IIS Express to serve the docs, and then show the home URL with your default browser. +[GitHub issues]: https://github.com/fsprojects/FSharp.Data.SqlClient/issues +[Repo Assist]: https://github.com/githubnext/agentics/blob/main/docs/repo-assist.md +