Skip to content

Commit 54d11e6

Browse files
committed
Update AGENTS.md about path join
1 parent c01ad33 commit 54d11e6

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<https://github.com/PyThaiNLP/pythainlp/blob/dev/tests/README.md>.
77
The document list test categories, their dependency sets,
88
and test naming conventions.
9-
- [ ] Use reStructuredText for docstring (PEP 287), targetting Sphinx.
9+
- [ ] Use reStructuredText for docstring (PEP 287), targeting Sphinx.
1010
- [ ] When possible, follow NLTK established convention of submodule
1111
name (tend to be a verb or a generic noun), function name, and
1212
configuration. Communicate this to the users during code review.
@@ -20,7 +20,7 @@
2020
the repo. Read its usage and information it generates at
2121
<https://github.com/PyThaiNLP/pythainlp/blob/dev/build_tools/analysis/README.md>.
2222
Mind that the analyzer can create false positives,
23-
please refer to Python tyep specification when in doubt.
23+
please refer to Python type specification when in doubt.
2424
- [ ] Complete type annotations for function, method, class, variable, etc.
2525
Maintain near-100% type annotation coverage.
2626
- [ ] Add tests for new functionality or behavior.
@@ -31,6 +31,9 @@
3131
- [ ] Major changes should be logged in the change log at
3232
<https://github.com/PyThaiNLP/pythainlp/blob/dev/CHANGELOG.md>.
3333
Provide issue number or PR number if available.
34+
- [ ] Do not use os.path.join();
35+
always use pythainlp.tools.safe_path_join() instead,
36+
to prevent path traversal vulnerabilities (CWE-22).
3437

3538
## Project contribution guidelines
3639

0 commit comments

Comments
 (0)