You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by he...@apache.org on 2026/06/19 08:44:15 UTC
(pekko-projection) 01/01: docs: add mandatory header workflow reminder to Licensing Rules
This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch docs/licensing-header-reminder
in repository https://gitbox.apache.org/repos/asf/pekko-projection.git
commit 21e246bedbf85c9713e4bc96af1e563328db0f75
Author: 虎鸣 <he...@alibaba-inc.com>
AuthorDate: Fri Jun 19 16:43:23 2026 +0800
docs: add mandatory header workflow reminder to Licensing Rules
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 dcb79db5..738931e4 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -16,6 +16,8 @@ If this file conflicts with community conventions, update this file.
## 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: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org