Skip to content

Commit cfed734

Browse files
authored
Update AGENTS.md with naming and consistency guidelines
Clarified naming conventions and noun number consistency guidelines.
1 parent 0c11d30 commit cfed734

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,17 @@
4242
- [ ] Do not use os.path.join();
4343
always use pythainlp.tools.safe_path_join() instead,
4444
to prevent path traversal vulnerabilities (CWE-22).
45-
- [ ] Naming conventions: Follows PEP 8.
45+
- [ ] Naming conventions: Follows PEP 8.
4646
Align new modules, classes, public APIs, and environment
47-
variables with NLTK conventions as the primary standard.
47+
variables with NLTK conventions as the primary standard,
48+
provided they suit the component's behavior.
4849
If NLTK offers no clear precedent, defer to established NLP
4950
frameworks in the following order of preference:
50-
spaCy, CoreNLP/Stanza, LangPipe, and Hugging Face,
51-
Ensure the chosen name accurately reflects the nature and
52-
behavior of the component.
51+
spaCy, CoreNLP/Stanza, LangPipe, and Hugging Face.
52+
- [ ] Noun number consistency: Maintain strict intentionality
53+
regarding singular vs. plural forms. Use singular names for
54+
classes representing a single entity and reserve plural
55+
names only for collections, utility modules, or clear aggregates.
5356

5457
## Project contribution guidelines
5558

0 commit comments

Comments
 (0)