Skip to content

Commit a34a743

Browse files
authored
Clarify nullability and documentation in AGENTS.md (HMCL-dev#6440)
1 parent 591fd51 commit a34a743

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ These rules apply to all Java code written or modified in this repository.
44

55
## Nullability
66

7-
- Annotate every class with JetBrains Annotations `@NotNullByDefault`.
8-
- Any type, field, parameter, return value, local variable, or generic type argument that may be `null` must be explicitly annotated with `@Nullable`.
9-
- Nullability must never be implicit.
7+
- Every class declared in a newly added Java source file must be annotated with JetBrains Annotations `@NotNullByDefault`.
8+
- When writing or modifying Java code, any type, field, parameter, return value, local variable, or generic type argument that may be `null` must be explicitly annotated with `@Nullable`.
9+
- Nullability in code being written or modified must never be implicit.
1010

1111
## Immutability
1212

@@ -15,6 +15,8 @@ These rules apply to all Java code written or modified in this repository.
1515

1616
## Documentation
1717

18+
Apply the following requirements when writing or modifying code. Do not use them as code-review criteria.
19+
1820
- Every class, field, and method must have documentation.
1921
- Documentation must use `///` Markdown-style Javadoc comments.
2022
- Keep documentation accurate and specific to the actual behavior, constraints, and side effects.

0 commit comments

Comments
 (0)