mirror of
https://github.com/data-privacy-stack/presidio.git
synced 2026-09-21 13:38:05 -05:00
Merge branch 'main' into replace-spacy-hf-pipeline
This commit is contained in:
@@ -111,7 +111,6 @@ recognizers:
|
||||
enabled: false # Country-specific defaults to false
|
||||
|
||||
# 4. docs/supported_entities.md (add row to appropriate table)
|
||||
# 5. CHANGELOG.md (under "Unreleased" section)
|
||||
```
|
||||
|
||||
**6. Comprehensive Test Coverage:**
|
||||
@@ -226,7 +225,6 @@ e2e-tests/tests/test_new_endpoint.py
|
||||
# 3. Add usage example
|
||||
docs/samples/python/new_feature_example.ipynb
|
||||
|
||||
# 4. Update CHANGELOG.md
|
||||
```
|
||||
|
||||
### Cross-Component Changes
|
||||
@@ -314,7 +312,6 @@ def test_case2()
|
||||
```markdown
|
||||
When adding a feature, update ALL of:
|
||||
|
||||
✅ CHANGELOG.md - Under "Unreleased" section
|
||||
✅ docs/supported_entities.md - For new entity types
|
||||
✅ docs/api-docs/api-docs.yml - For API changes
|
||||
✅ README.md - For major features
|
||||
@@ -323,6 +320,10 @@ When adding a feature, update ALL of:
|
||||
✅ Update docstrings based on the reST docstring format (:param:, :return:, :raises:, :example:)
|
||||
```
|
||||
|
||||
Do not update `CHANGELOG.md` in a PR. Before each version bump, changelog
|
||||
entries for the current release are generated from merged PRs. Per-PR changelog
|
||||
edits create unnecessary merge conflicts.
|
||||
|
||||
**2. Pattern Source Documentation:**
|
||||
```python
|
||||
# In recognizer docstring or comments
|
||||
@@ -649,13 +650,16 @@ pytest -v # Run all E2E tests
|
||||
**See section 8 in Review Priorities above for comprehensive documentation guidelines.**
|
||||
|
||||
When adding features, update:
|
||||
- **CHANGELOG.md** - Under "Unreleased" section
|
||||
- **docs/supported_entities.md** - For new entity types
|
||||
- **docs/api-docs/api-docs.yml** - For API changes
|
||||
- **README.md** - For major features
|
||||
- **Docstrings** - All public classes and methods (ensure proper formatting for API doc generation)
|
||||
- **docs/samples/** - Add usage examples for complex new features
|
||||
|
||||
Do not update `CHANGELOG.md` in a PR. Its current-release entries are generated
|
||||
from merged PRs before each version bump, avoiding conflicts between concurrent
|
||||
contributions.
|
||||
|
||||
## Reference Documentation
|
||||
|
||||
**Consult these for detailed guidance:**
|
||||
|
||||
+3
-5
@@ -24,11 +24,9 @@ By submitting a contribution, you represent that you have the legal right to con
|
||||
|
||||
Commit message should be clear, explaining the committed changes.
|
||||
|
||||
Update CHANGELOG.md:
|
||||
|
||||
Under Unreleased section, use the category which is most suitable for your change (changed/removed/deprecated).
|
||||
Document the change with simple readable text and push it as part of the commit.
|
||||
Next release, the change will be documented under the new version.
|
||||
Do not update `CHANGELOG.md` as part of your PR. Before each version bump, the
|
||||
changelog entries for the current release are generated from merged PRs.
|
||||
Per-PR changelog edits create unnecessary merge conflicts with other contributions.
|
||||
|
||||
## Getting started with the code
|
||||
|
||||
|
||||
Reference in New Issue
Block a user