|
1 | | -Contributing to FSharp.Data |
2 | | -======================= |
3 | | - |
4 | | -This page should provide you with some basic information if you're thinking about |
5 | | -contributing to the FSharp.Data package. It gives a brief summary of the library |
6 | | -structure, how type providers are written and how the FSharp.Data package handles |
7 | | -multi-targeting (to make the providers available for Desktop as well |
8 | | -as Portable libraries). |
9 | | - |
10 | | - * This page can be edited by sending a pull request to FSharp.Data on GitHub, so |
11 | | - if you learn something when playing with FSharp.Data, please record your |
12 | | - [findings here](https://github.com/fsharp/FSharp.Data/blob/master/CONTRIBUTING.md)! |
13 | | - |
14 | | - * If you want to discuss a feature (a good idea!), or if you want to look at |
15 | | - suggestions how you might contribute, check out the |
16 | | - [Issue list](https://github.com/fsharp/FSharp.Data/issues) on GitHub or send |
17 | | - an email to the [F# Open-Source mailing list](http://groups.google.com/group/fsharp-opensource). |
18 | | - |
19 | | - * Easier tasks to get started with are marked with the [up-for-grabs](https://github.com/fsharp/FSharp.Data/labels/up-for-grabs) tag. |
| 1 | +# Contributing to FSharp.Data |
| 2 | + |
| 3 | +FSharp.Data is primarily maintained through agentic development under human guidance. Maintainers |
| 4 | +review and discuss proposed work, then direct coding agents to make the complete change, including |
| 5 | +implementation, tests, documentation, samples, and other affected files. |
| 6 | + |
| 7 | +## Start With an Issue |
| 8 | + |
| 9 | +We generally prefer contributions as [GitHub issues] rather than pull requests. Use an issue to |
| 10 | +report a bug, request a feature, suggest a documentation improvement, or propose another change. |
| 11 | +Search for an existing report first and add useful context there instead of creating a duplicate. |
| 12 | + |
| 13 | +A useful issue explains the problem or desired outcome, why the change would be valuable, and steps |
| 14 | +to reproduce a bug with relevant version and platform details. Examples, logs, API sketches, proposed |
| 15 | +changes, patches, and links to forks or branches are welcome. Maintainers may refine the scope with |
| 16 | +you and then assign the issue to an agent to implement and validate the complete change. |
| 17 | + |
| 18 | +## Repo Assist |
| 19 | + |
| 20 | +[Repo Assist] is an automated AI assistant that runs regularly in this repository. It may triage or |
| 21 | +respond to issues, investigate bugs, suggest improvements, and attempt implementations as draft pull |
| 22 | +requests. Its comments and pull requests identify it as automated, and its work remains subject to |
| 23 | +human review. Repo Assist does not merge pull requests or make final maintenance decisions. |
| 24 | + |
| 25 | +Maintainers can also invoke Repo Assist with `/repo-assist <instructions>` to perform a specific |
| 26 | +agentic task, such as investigating an issue, preparing a fix, adding tests, or updating |
| 27 | +documentation. These directed tasks follow the same review process as its scheduled work. |
| 28 | + |
| 29 | +## Pull Requests |
| 30 | + |
| 31 | +Every pull request must have a matching issue that has been discussed with the maintainers. Open the |
| 32 | +issue before investing substantial effort, especially for new features, public API changes, or broad |
| 33 | +refactoring, and link the pull request to it. |
| 34 | + |
| 35 | +Submitting a pull request does not guarantee that its commits will be merged. Maintainers may close |
| 36 | +the pull request and use the issue as the basis for an agent-produced implementation instead. The |
| 37 | +original report, analysis, and proposed code remain valuable inputs to that work. |
| 38 | + |
| 39 | +If a pull request is the agreed approach, keep it focused on one issue, follow the existing project |
| 40 | +conventions, add deterministic tests for behavior changes, update documentation when applicable, and |
| 41 | +run the relevant build, test, and formatting checks described in [AGENTS.md]. |
20 | 42 |
|
21 | 43 | ## General info about developing type providers |
22 | 44 |
|
@@ -103,3 +125,7 @@ dotnet fsdocs watch |
103 | 125 | You can now edit documentation and the file watcher will pick up changes, regenerate the docs, and serve them up locally for you to view in a browser. |
104 | 126 |
|
105 | 127 | Docs updates are pushed to the website every time a pull request is merged. |
| 128 | + |
| 129 | +[AGENTS.md]: AGENTS.md |
| 130 | +[GitHub issues]: https://github.com/fsprojects/FSharp.Data/issues |
| 131 | +[Repo Assist]: https://github.com/githubnext/agentics/blob/main/docs/repo-assist.md |
0 commit comments