|
| 1 | +--- |
| 2 | +title: AI use policy |
| 3 | +description: How to use AI tools when contributing to BeeHive — you are accountable for what you submit. |
| 4 | +--- |
| 5 | + |
| 6 | +# AI use policy |
| 7 | + |
| 8 | +BeeHive welcomes contributions made with the help of AI tools — but **you are |
| 9 | +responsible for everything you submit**. This page sets out how to use them well. |
| 10 | + |
| 11 | +## The core principle |
| 12 | + |
| 13 | +We are humans who enjoy working with other humans. Use whatever tools help you, |
| 14 | +but you are ultimately accountable for the boards, code, and documentation you |
| 15 | +contribute. If you would not be comfortable explaining a change and standing |
| 16 | +behind it, it is not ready to submit. |
| 17 | + |
| 18 | +## Please don't |
| 19 | + |
| 20 | +- Let an AI agent open pull requests on your behalf. |
| 21 | +- Submit a board design, recipe, code, or docs change you have not personally |
| 22 | + understood and tested. |
| 23 | +- Let a chatbot carry on a conversation (an issue thread, a PR review) for you. |
| 24 | + |
| 25 | +Pull requests that appear to ignore these guidelines may be closed without |
| 26 | +review — checking un-vetted machine output costs maintainers more time than it |
| 27 | +saves. |
| 28 | + |
| 29 | +## Using AI to build and code |
| 30 | + |
| 31 | +- **Get familiar with what you are changing first.** Understanding the board, |
| 32 | + the [design rules](introduction/design-rules.md), or the code you are touching |
| 33 | + lets you write better prompts *and* judge whether the output is right. |
| 34 | +- **Don't trust an assistant's claims about how BeeHive works.** LLMs are often |
| 35 | + confidently wrong, even about things the docs answer directly. Check against |
| 36 | + the design rules, the board's schematics, or a real device. |
| 37 | +- **Test on hardware.** A recipe or snippet that looks plausible is not a |
| 38 | + contribution until it actually runs on the boards it claims to. |
| 39 | +- **Keep pull requests small and focused,** even if a tool generated everything |
| 40 | + in one go. One board, one recipe, or one fix per PR is far easier to review. |
| 41 | +- **Edit AI-written comments and prose.** Prefer clarity and brevity over |
| 42 | + exhaustive, generic text; delete comments that just restate the code. |
| 43 | + |
| 44 | +## Using AI to communicate |
| 45 | + |
| 46 | +- **Say why, not what.** A PR description that merely restates the diff adds |
| 47 | + nothing — explain your reasoning and what you tested. |
| 48 | +- **Fill in the templates yourself.** Issue and PR templates exist to save |
| 49 | + everyone time; complete them rather than having a tool do it. |
| 50 | +- **Verify anything you post.** Don't paste unchecked AI output into an issue or |
| 51 | + a pull request. |
| 52 | +- **Link, don't quote.** Pointing to the primary source — a datasheet, the docs, |
| 53 | + a repo file — beats quoting an LLM. If you must quote one, put it in a |
| 54 | + `>` blockquote so it is clearly machine output, not your own words. |
| 55 | +- **Clarity over polish.** A clear, slightly imperfect message beats a |
| 56 | + perfectly-worded one that hides the point. |
| 57 | + |
| 58 | +## Attribution |
| 59 | + |
| 60 | +This policy is adapted from the |
| 61 | +[napari AI use policy](https://napari.org/dev/developers/contributing/ai.html), |
| 62 | +which was itself adapted from Zulip's AI usage guidelines. |
0 commit comments