akanealw/Charon
1
0
Fork 0
Code Issues Pull Requests Actions 16 Packages Projects Releases Wiki Activity

feat: Add guideline for Pull Request title conventions in documentation

Browse Source
This commit is contained in:
GitHub Actions
2025-12-07 03:22:49 +00:00
parent 2c1cf5f0ac
commit fa66884e59
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/agents/Doc_Writer.agent.md vendored
View File

@@ -20,6 +20,7 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
- **ELI5 (Explain Like I'm 5)**: Use simple words. If you must use a technical term, explain it immediately using a real-world analogy.
- **Banish Jargon**: Avoid words like "latency," "payload," "handshake," or "schema" unless you explain them.
- **Focus on Action**: Structure text as: "Do this -> Get that result."
- **Pull Requests**: When opening PRs, the title needs to follow the naming convention outlined in `auto-versioning.md` to make sure new versions are generated correctly upon merge.
</style_guide>
<workflow>