@@ -111,7 +111,6 @@ recognizers:
111111 enabled: false # Country-specific defaults to false
112112
113113# 4. docs/supported_entities.md (add row to appropriate table)
114- # 5. CHANGELOG.md (under "Unreleased" section)
115114```
116115
117116** 6. Comprehensive Test Coverage:**
@@ -226,7 +225,6 @@ e2e-tests/tests/test_new_endpoint.py
226225# 3. Add usage example
227226docs/samples/python/new_feature_example.ipynb
228227
229- # 4. Update CHANGELOG.md
230228```
231229
232230### Cross-Component Changes
@@ -314,7 +312,6 @@ def test_case2()
314312``` markdown
315313When adding a feature, update ALL of:
316314
317- ✅ CHANGELOG.md - Under "Unreleased" section
318315✅ docs/supported_entities.md - For new entity types
319316✅ docs/api-docs/api-docs.yml - For API changes
320317✅ README.md - For major features
@@ -323,6 +320,10 @@ When adding a feature, update ALL of:
323320✅ Update docstrings based on the reST docstring format (:param:, :return:, :raises:, :example:)
324321```
325322
323+ Do not update ` CHANGELOG.md ` in a PR. Before each version bump, changelog
324+ entries for the current release are generated from merged PRs. Per-PR changelog
325+ edits create unnecessary merge conflicts.
326+
326327** 2. Pattern Source Documentation:**
327328``` python
328329# In recognizer docstring or comments
@@ -649,13 +650,16 @@ pytest -v # Run all E2E tests
649650** See section 8 in Review Priorities above for comprehensive documentation guidelines.**
650651
651652When adding features, update:
652- - ** CHANGELOG.md** - Under "Unreleased" section
653653- ** docs/supported_entities.md** - For new entity types
654654- ** docs/api-docs/api-docs.yml** - For API changes
655655- ** README.md** - For major features
656656- ** Docstrings** - All public classes and methods (ensure proper formatting for API doc generation)
657657- ** docs/samples/** - Add usage examples for complex new features
658658
659+ Do not update ` CHANGELOG.md ` in a PR. Its current-release entries are generated
660+ from merged PRs before each version bump, avoiding conflicts between concurrent
661+ contributions.
662+
659663## Reference Documentation
660664
661665** Consult these for detailed guidance:**
0 commit comments