This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko-connectors.git
The following commit(s) were added to refs/heads/main by this push:
new ceba32d76 docs: add mandatory header workflow reminder to Licensing
Rules (#1698)
ceba32d76 is described below
commit ceba32d7686f87573293548a543f29a12bfc209e
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Fri Jun 19 17:02:51 2026 +0800
docs: add mandatory header workflow reminder to Licensing Rules (#1698)
Motivation:
Agents can miss the rule about not hand-writing license headers and
accidentally paste the wrong header (e.g. the Akka-derived header for
new code).
Modification:
Add a prominent blockquote reminder at the top of the Licensing Rules
section that spells out the mandatory workflow: create file without
header -> sbt headerCreateAll -> done.
Result:
Agents see the workflow before reading the detailed rules, reducing
the chance of hand-writing an incorrect header.
Tests:
Not run - docs only
References:
None - process improvement
---
AGENTS.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index 371a49dbe..0d1b066b9 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -16,6 +16,8 @@ Follow `CONTRIBUTING.md`. If this file conflicts with
`CONTRIBUTING.md`, follow
## Licensing Rules
+> **⚠️ Mandatory workflow for new files:** Create the file without any header
→ run `sbt headerCreateAll` → sbt adds the correct header automatically. Never
hand-write or copy-paste a license header.
+
- Do not hand-write or invent license headers. Let sbt manage them.
- For new files, run `sbt headerCreateAll` to add the correct header. Do not
manually paste header text.
- Run `sbt +headerCheckAll` to verify all files carry the expected header.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
