added a tldr to the CONTRIBUTING.md guidelines
This commit is contained in:
@@ -1,5 +1,33 @@
|
|||||||
# CONTRIBUTING
|
# CONTRIBUTING
|
||||||
|
|
||||||
|
## Tldr
|
||||||
|
|
||||||
|
**Do's**
|
||||||
|
|
||||||
|
- Be concise
|
||||||
|
- Follow the [Formatting Rules](#formatting-rules) to the best of your ability
|
||||||
|
- Segment larger changes into managable, reviewable commits
|
||||||
|
- Leave a trail of your development so I can tell you put some effort in (doesnt really
|
||||||
|
apply to smaller commits)
|
||||||
|
- Write your own code
|
||||||
|
- Leave some way of crediting your work
|
||||||
|
- Disclose the capacity in which you used AI. Most of the time, anything more than making
|
||||||
|
examples or helping you understand the codebase will be disallowed. As little AI code
|
||||||
|
should make it to production as possible
|
||||||
|
|
||||||
|
**Dont's**
|
||||||
|
|
||||||
|
- Report upstream issues to me (ie an issue with the app itself, not my config)
|
||||||
|
- Make major structural changes
|
||||||
|
- Submit chore commits such as updating the flake, I can do that myself
|
||||||
|
- Add new hosts for no reason, make your own flake and import the modules you want for
|
||||||
|
your host
|
||||||
|
- Majorly change existing hosts for your own preference
|
||||||
|
- Ask AI to fix your issues and expect me to merge changes
|
||||||
|
- Delete existing modules. Executive decisions like that will be made at my disgression,
|
||||||
|
and will be done as non-destructively as possible, such as moving those modules to a
|
||||||
|
"deprecated" branch in the future.
|
||||||
|
|
||||||
## General format
|
## General format
|
||||||
|
|
||||||
All emails regarding this repo (or another) should have a subject prepended with the
|
All emails regarding this repo (or another) should have a subject prepended with the
|
||||||
|
|||||||
Reference in New Issue
Block a user