dsmiley commented on code in PR #4530:
URL: https://github.com/apache/solr/pull/4530#discussion_r3421120999
##########
dev-docs/changelog.adoc:
##########
@@ -53,6 +53,37 @@ links:
url: https://issues.apache.org/jira/browse/SOLR-3333
----
+=== Changelog Types Reference
+
+[cols="1h,2,3", options="header"]
+|===
+| Type | Description | When to Use (Examples)
+
+| added
+| For completely new features, capabilities, or opt-in functionality.
Review Comment:
```suggestion
| For changes requiring a user to take action to use (opt-in). Could be
completely new features or simply new configuration values on existing
features. Documented.
```
Emphasizing opt-in as the first order gating category.
##########
dev-docs/changelog.adoc:
##########
@@ -53,6 +53,37 @@ links:
url: https://issues.apache.org/jira/browse/SOLR-3333
----
+=== Changelog Types Reference
+
+[cols="1h,2,3", options="header"]
+|===
+| Type | Description | When to Use (Examples)
+
+| added
+| For completely new features, capabilities, or opt-in functionality.
+| Adding a new API endpoint, a new query shortcut, or a new optional
configuration parameter.
+
+| changed
+| For changes to existing functionality that alter current behavior.
+| Modifying an existing default behavior, updating an internal dependency, or
refactoring a core algorithm.
+
+| deprecated
+| For features or APIs that are slated for removal in future releases.
+| Marking an old configuration option or an old method as deprecated.
+
+| removed
+| For features or APIs that have been completely removed from the codebase.
+| Deleting a feature that was previously marked as deprecated.
+
+| fixed
+| For any bug fixes or corrections to unintended behavior.
+| Fixing a `NullPointerException`, correcting data corruption issues, or
resolving UI glitches.
+
+| security
Review Comment:
@janhoy lets drop this. This is an independent cross-cutting concern.
Perhaps we might have a separate loose tagging mechanism with values like
"security", "dependency", "perf" -- or just not bother.
##########
dev-docs/changelog.adoc:
##########
@@ -53,6 +53,37 @@ links:
url: https://issues.apache.org/jira/browse/SOLR-3333
----
+=== Changelog Types Reference
+
+[cols="1h,2,3", options="header"]
+|===
+| Type | Description | When to Use (Examples)
+
+| added
+| For completely new features, capabilities, or opt-in functionality.
+| Adding a new API endpoint, a new query shortcut, or a new optional
configuration parameter.
+
+| changed
+| For changes to existing functionality that alter current behavior.
+| Modifying an existing default behavior, updating an internal dependency, or
refactoring a core algorithm.
Review Comment:
```suggestion
| Modifying behavior or performance of existing requests/configuration.
```
No: Not usually a dependency update. Not usually a refactoring. Both of
those are usually "other".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
