mirror of
https://github.com/badlogic/pi-mono.git
synced 2026-11-05 23:37:25 +00:00
docs: require clear concrete explanations
This commit is contained in:
parent
5cfa30cc2c
commit
4fbdc63ca3
1 changed files with 3 additions and 0 deletions
|
|
@ -6,6 +6,9 @@
|
|||
- No emojis in commits, issues, PR comments, or code
|
||||
- No fluff or cheerful filler text (e.g., "Thanks @user" not "Thanks so much @user!")
|
||||
- Technical prose only, be direct
|
||||
- Use concise, clear, simple language. Define unavoidable jargon before using it.
|
||||
- Explain non-trivial designs and problems as: problem, concrete example or short trace, then solution. State why the solution is necessary and distinguish it from optional complexity.
|
||||
- Prefer concrete behavior and small illustrations over abstract summaries, dense terminology, or unexplained lists of changes.
|
||||
- When the user asks a question, answer it first before making edits or running implementation commands.
|
||||
- When responding to user feedback or an analysis, explicitly say whether you agree or disagree before saying what you changed.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue