This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/commons-secure-xml.git
The following commit(s) were added to refs/heads/main by this push:
new 38f9988 Reference parent AGENTS.md file
38f9988 is described below
commit 38f99887200cdd76698522b914e407dee23c781f
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Oct 31 09:03:41 2026 -0400
Reference parent AGENTS.md file
---
AGENTS.md | 31 +------------------------------
1 file changed, 1 insertion(+), 30 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index bad5337..66e5c84 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -19,36 +19,7 @@ limitations under the License.
Guidance for AI coding agents working in this repository.
-## Formatting
-
-### Javadoc
-
-1. **Wrap at 160 columns**, not 80.
- Count the leading ` * ` prefix as part of the line.
- Keep wrapping natural (do not break inside a `{@link ...}` or across a tag
boundary if it can be avoided).
-2. **Getter summaries start with "Gets"; setter summaries start with "Sets".**
- Prefer these verb forms over "Returns".
- For non getter/setter methods keep a short verb phrase (for example
"Configures", "Hardens", "Dispatches").
-3. **Javadoc style**:
- Key rules:
- - Open on its own line with `/**`,
- close on its own line with ` */`,
- align intermediate lines with a single leading ` * `.
- - The first sentence is a short summary fragment.
- It is the only part that appears in class/method index listings, so keep
it self-contained.
- Details (what is secured, thread-safety, edge cases) belong in subsequent
paragraphs, not bolted onto the summary.
- - Separate paragraphs with a blank `*` line.
- Prefix every paragraph *except the first* with a `<p>` tag at the start
of the first word.
- **Do** close with `</p>`.
- - Block tags appear in the order `@param`, `@return`, `@throws`,
`@deprecated`. No empty descriptions.
- - Javadoc is present on every public class and every public or protected
member,
- with the standard exceptions (overrides, self-explanatory members,
trivial `equals`/`hashCode`).
-
-### Prose
-
-- No em-dashes (`—`) in Javadoc, comments, commit messages, or documentation.
- Use commas, colons, parentheses, or a new sentence instead. This applies to
- HTML entities too (`—`).
+This file adds to the AGENTS.md file in
[AGENTS.md](https://raw.githubusercontent.com/apache/commons-parent/refs/heads/master/AGENTS.md)
### Commits
