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

feat: Update documentation guidelines for history-rewrite PRs

Browse Source
This commit is contained in:
GitHub Actions
2025-12-13 00:50:44 +00:00
parent 018942e121
commit cc9e4a6c28
2 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/agents/Doc_Writer.agent.md
+1
View File
@@ -22,6 +22,7 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
- **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.
- **History-Rewrite PRs**: If a PR touches files in `scripts/history-rewrite/` or `docs/plans/history_rewrite.md`, include the checklist from `.github/PULL_REQUEST_TEMPLATE/history-rewrite.md` in the PR description.
</style_guide>
<workflow>