anil.recoil.org
The unpac monorepo manager self-hosting as a monorepo using unpac
Add advice about using AI for code generation
authored by
Patrick Ferris
and committed by
GitHub
a65fd2e6
f8c94418
+11
HACKING.md
+11
HACKING.md
···
135
135
`ocamlformat` may be useful to get badly messed up code to a baseline unformatted state,
136
136
from which human formatting can be added where needed.
137
137
138
+
## AI-generated Code
139
+
140
+
Contributing to Eio should not be done _solely_ using "AI tools" such as ChatGPT. This is for a few reasons:
141
+
142
+
1. **It obfuscates how you think**. Purely AI-generated code tells us little about how you think and the problems you might be having. This makes it harder to provide good feedback on PRs and issues.
143
+
2. **It is often more work to review**. Particularly for the OCaml ecosystem and libraries like Eio, it seems that these tools are not very good and generate a lot of believable code that is in actual fact completely wrong. PR comments and the code submitted with them can say completely different things.
144
+
3. **It is a grey area for licensing**. Models like ChatGPT have been trained on lots of code with different licenses and has been known to simply copy code as an answer to a prompt. We would like to avoid this headache as best we can.
145
+
146
+
Use AI tools, if you wish, to help you understand OCaml and Eio. Do not offload all of the work of a PR or a comment to these tools.
147
+
138
148
[dscheck]: https://github.com/ocaml-multicore/dscheck
149
+