Skip to content

Commit b8cfbfb

Browse files
committed
Add deterrence against AI slop.
1 parent 3f5a5d1 commit b8cfbfb

2 files changed

Lines changed: 24 additions & 15 deletions

File tree

‎.github/ISSUE_TEMPLATE/issue.md‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,18 @@ assignees: ''
77

88
---
99

10-
<!--
10+
## Checklist
1111

12-
Thanks for taking the time to report an issue!
12+
* [ ] I searched the [FAQ](https://websockets.readthedocs.io/en/stable/faq/index.html) and didn't find an answer.
13+
* [ ] I search [issues](https://github.com/python-websockets/websockets/issues?q=is%3Aissue) and didn't find an earlier report.
14+
* [ ] I personally encountered this problem. I can explain the symptoms and the consequences without relying on an AI coding agent.
15+
* [ ] I wrote a short, specific issue description that makes it easy for maintainers to understand the problem and the consequences.
16+
* [ ] I am aware that maintainers have AI coding agents. Merely throwing an AI at an issue wastes their time. It comes across as a lack of respect.
1317

14-
Did you check the FAQ? Perhaps you'll find the answer you need:
15-
https://websockets.readthedocs.io/en/stable/faq/index.html
18+
## Problem
1619

17-
Is your question really about asyncio? Perhaps the dev guide will help:
18-
https://docs.python.org/3/library/asyncio-dev.html
20+
Explain which problem you faced in a real-life situation and what consequences it has. Theoretical issues flagged by AI coding agents are of no interest.
1921

20-
Did you look for similar issues? Please keep the discussion in one place :-)
21-
https://github.com/python-websockets/websockets/issues?q=is%3Aissue
22+
## Reproduction
2223

23-
Is your issue related to cryptocurrency in any way? Please don't file it.
24-
https://websockets.readthedocs.io/en/stable/project/support.html#cryptocurrency-users
25-
26-
For bugs, providing a reproduction helps a lot. Take an existing example and tweak it!
27-
https://github.com/python-websockets/websockets/tree/main/example
28-
29-
-->
24+
If possible, provide a minimal reproduction, ideally based on an [existing example](https://github.com/python-websockets/websockets/tree/main/example).

‎.github/pull_request_template.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Checklist
2+
3+
* [ ] I personally discussed the issue with a maintainer before opening this pull request. I understood and followed their requirements.
4+
* [ ] I reviewed the design choices and implementation details of the changes. I can explain them without relying on an AI coding agent.
5+
* [ ] I wrote a short, specific pull request description that makes it easy for maintainers to understand the problem and the solution.
6+
* [ ] I am aware that maintainers have AI coding agents. Merely throwing an AI at an issue wastes their time. It comes across as a lack of respect.
7+
8+
## Problem
9+
10+
Explain which problem you faced in a real-life situation and what consequences it has. Theoretical issues flagged by AI coding agents are of no interest.
11+
12+
## Solution
13+
14+
Explain your approach for fixing the problem, with pros and cons. Describe alternative approaches that you considered and why you discarded them.

0 commit comments

Comments
 (0)