Skip to content

Commit 1b5d966

Browse files
authored
docs: AI usage policy (#3276)
* docs: AI usage policy * docs: AI usage policy
1 parent 5499299 commit 1b5d966

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ markdown-toc --maxdepth=2 -i CONTRIBUTING.md
2727
- [Windows](#windows)
2828
- [Pull Request](#pull-request)
2929
* [Subject](#subject)
30+
- [AI Usage Policy: Highly Discouraged](#ai-usage-policy-highly-discouraged)
31+
* [nvim-tree Is A Community Project](#nvim-tree-is-a-community-project)
32+
* [The Burden Of Review Must Not Increase](#the-burden-of-review-must-not-increase)
33+
* [AI Generated PR Rules](#ai-generated-pr-rules)
3034

3135
<!-- tocstop -->
3236

@@ -38,7 +42,7 @@ Language server: [luals](https://luals.github.io)
3842

3943
Lint: [luacheck](https://github.com/lunarmodules/luacheck/)
4044

41-
nvim-tree.lua migrated from stylua to EmmyLuaCodeStyle ~2024/10. `vim.lsp.buf.format()` may be used as it is the default formatter for luals, using an embedded [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle)
45+
nvim-tree migrated from stylua to EmmyLuaCodeStyle ~2024/10. `vim.lsp.buf.format()` may be used as it is the default formatter for luals, using an embedded [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle)
4246

4347
Formatting: [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle): `CodeFormat` executable
4448

@@ -232,3 +236,45 @@ Available types:
232236
If in doubt, look at previous commits.
233237

234238
See also [The Conventional Commits ultimate cheatsheet](https://gist.github.com/gabrielecanepa/fa6cca1a8ae96f77896fe70ddee65527)
239+
240+
# AI Usage Policy: Highly Discouraged
241+
242+
## nvim-tree Is A Community Project
243+
244+
nvim-tree is a work of passion, building a community of free thinking individuals who contribute highly polished, elegant and maintainable code. Community members range from novices to professionals and all are welcome. Teaching, encouraging and celebrating the growth of less experienced developers is of great importance.
245+
246+
AI generated code is discouraged as this doesn't match these nvim-tree values.
247+
248+
Human PR reviews will always be prioritised over AI generated PRs.
249+
250+
## The Burden Of Review Must Not Increase
251+
252+
There must be a human in the loop at all times. The contributor is the author of and is fully accountable for AI generated contributions.
253+
254+
AI generated PRs have low, or even non-existent entry level. Human generated PRs require you to be motivated, do research, familiarise yourself with code, make effort to write the code and test it.
255+
256+
Low effort or unqualified code increases the burden of review and testing on maintainers, who are limited in time.
257+
258+
Contributors must:
259+
260+
- Read and review all generated code and documentation before raising a PR
261+
- Fully understand all code and documentation
262+
- Be able to answer any questions during review
263+
264+
## AI Generated PR Rules
265+
266+
The PR description and comments must be written by the contributor, with no AI assistance beyond grammar or English translations.
267+
268+
The description must:
269+
270+
- Describe the solution design, justifying all decisions
271+
- Clearly state which AI was used
272+
- List which code and documentation was written by a human and which was written by AI
273+
- Detail all testing performed
274+
275+
There must be far greater than usual number of detailed, explicit comments:
276+
277+
- File level: overview of the changes made
278+
- Line level: 1-2 comments per function/method
279+
280+
Do not enable or use any AI review tools (e.g. Copilot) on the Pull Request.

0 commit comments

Comments
 (0)