clean up headings and add TOC for templates (#538)

This should help keep it tidy and put the important info up front

Reviewed-on: https://codeberg.org/small-hack/open-slopware/pulls/538
This commit is contained in:
jessebot 2026-04-26 13:22:58 +02:00 committed by JesseBot
commit d889360d48

View file

@ -6,6 +6,26 @@ Before you proceed, read our [Tips for Success](#tips-for-success).
Would you like to improve these templates or add additional sections? Please feel free to submit a PR to do so and we'll discuss it :)
## Tips for Success
- Do this in the public forum, issue tracker, discussions, etc.
- Avoid using direct messages (otherwise you'd need to share screenshots of your direct message which could cause friction)
- Avoid using places like discord servers unless that is the ONLY place a project does Issue Triage
- Personalize the template a bit before sending it:
- Add how long you've been using the software.
- Add what the project means to you.
- Add the name of the project in the opening
- Add your name at the bottom.
- Be nice! *We cannot stress this enough*: Be Kind!
- Do not shame or threaten the project you are reaching out to, especially not with this list.
- You may not want to include every section, depending on the culture surrounding the project you are contacting. Use your best judgement.
# Templates
* [Appeal to Ethics Template](#appeal-to-ethics-template)
* [Appeal to Code Quality Template](#appeal-to-code-quality-template)
* [Appeal to Fear of Legal Ramfification Template](#appeal-to-fear-of-legal-ramfification-template)
## Appeal to Ethics Template
```markdown
@ -64,17 +84,3 @@ Feel free to submit a PR to fill this one in.
## Appeal to Fear of Legal Ramfification Template
Feel free to submit a PR to fill this one in.
## Tips for Success
- Do this in the public forum, issue tracker, discussions, etc.
- Avoid using direct messages (otherwise you'd need to share screenshots of your direct message which could cause friction)
- Avoid using places like discord servers unless that is the ONLY place a project does Issue Triage
- Personalize the template a bit before sending it:
- Add how long you've been using the software.
- Add what the project means to you.
- Add the name of the project in the opening
- Add your name at the bottom.
- Be nice! *We cannot stress this enough*: Be Kind!
- Do not shame or threaten the project you are reaching out to, especially not with this list.
- You may not want to include every section, depending on the culture surrounding the project you are contacting. Use your best judgement.