Skip to content

Commit 2f68382

Browse files
committed
Update topic templates
No LLM usage for code. Discourage LLM usage for bug reports. Trim down other instructions.
1 parent a844569 commit 2f68382

2 files changed

Lines changed: 42 additions & 28 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,32 @@ name: 🪳 Report a bug
44
about: Report a defect. Do not use this for support requests and feature suggestions.
55
---
66

7-
<!-- We now only use the issue tracker for issues, i.e., bugs and features
8-
that we have decided to work on. If you are asking for help, want to make
9-
a suggestion, or are unsure, then please open a discussion. -->
7+
Please use your own words.
8+
Please use your own brain.
109

11-
<!-- Please use your own words. If you really must use a LLM, at least
12-
disclose that upfront.-->
10+
Avoid stochastic parrots!
11+
Avoid LLMs!
12+
13+
▄████▄ ▄▄ ▄▄ ▄▄▄ ▄▄ ▄▄▄▄ ▄████ ▄▄▄▄▄ ▄▄ ▄▄ ▄████▄ ██
14+
██▄▄██ ██▄██ ██▀██ ██ ██▀██ ██ ▄▄▄ ██▄▄ ███▄██ ██▄▄██ ██
15+
██ ██ ▀█▀ ▀███▀ ██ ████▀ ▀███▀ ██▄▄▄ ██ ▀██ ██ ██ ██
16+
17+
If you have already used an LLM to investigate an issue, don't post a generated wall of text. A human has to read and verify all that. Please do that work yourself and then use your own words to describe the relevant findings.
18+
19+
Disclose the LLM usage upfront.
20+
21+
======================================================================
22+
23+
We use this issue tracker only for issues suspected to be caused by bugs. If you need help or want to make a suggestion, please instead open a discussion.
24+
25+
======================================================================
26+
27+
Before reporting a defect, please try to reproduce the issue using the latest releases or snapshots of all involved packages. Mention the versions you used.
28+
29+
Likewise try to reproduce it using an Emacs instance, in which only this package and its dependencies have been loaded. Other packages or your configuration should not be loaded.
30+
31+
======================================================================
32+
33+
Explain (1) what behavior you expected, (2) what behavior you observed, (3) and how we can reproduce the issue.
34+
35+
Do "M-x magit-version", trigger the issue again, and post the backtrace.

.github/PULL_REQUEST_TEMPLATE

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,20 @@
1-
=================================================================
2-
Please use your own words
3-
=================================================================
1+
Please use your own words.
2+
Please use your own brain.
43

5-
Please use your own words, in this summary, commit messages and code. If you really must use a LLM, at least disclose that upfront. Code written by a LLM is not accepted.
4+
No stochastic parrots!
5+
No LLMs!
66

7-
=================================================================
8-
Use a dedicated feature branch
9-
=================================================================
7+
▐ ▄ ▄▄▄· ▪
8+
•█▌▐█▪ ▐█ ▀█ ██
9+
▐█▐▐▌ ▄█▀▄ ▄█▀▀█ ▐█
10+
██▐█▌▐█▌.▐▌ ▐█ ▪▐▌▐█▌
11+
▀▀ █▪ ▀█▄▀▪ ▀ ▀ ▀▀▀
1012

11-
Please use a dedicated feature branch for your feature request, instead of asking us to merge "your-fork/master" into "origin/master". The use of dedicated branches makes it much more convenient to deal with pull-requests, especially when using Magit to do so.
12-
13-
If you were about to open a pull-request asking us to merge your version of "master", then see [1] for instructions on how to quickly fix that and some information on why we ask you to do so.
14-
15-
Additionally we ask you to allow us to push to the branch you want us to merge. We might want to push additional commits and/or make minor changes. Please make sure the box next to "Allow edits from maintainers" is checked before creating the pull-request.
16-
17-
[1]: https://github.com/magit/magit/wiki/Dedicated-pull-request-branches
18-
19-
=================================================================
20-
What you should write here
21-
=================================================================
13+
Before making significant changes or additions, consider first opening an "idea" discussion. For trivial changes, skip that step.
2214

2315
Please summarize the changes made in the commits. Explain why you are making these changes, not just what changes you are making. This also applies to the commit messages.
2416

25-
=================================================================
26-
How to update the manual
27-
=================================================================
28-
29-
Edit only "borg.org". To update "borg.texi" run "make texi".
17+
Please also
18+
- use a dedicated feature branch instead of working on "main"
19+
- use Emacs even for miniscule changes, not the web interface
20+
- edit "docs/*.org", not "docs/*.texi", then run "make texi"

0 commit comments

Comments
 (0)