dsmiley commented on code in PR #4530: URL: https://github.com/apache/solr/pull/4530#discussion_r3433091916
########## dev-docs/changelog.adoc: ########## @@ -55,33 +55,37 @@ links: === Changelog Types Reference -[cols="1h,2,3", options="header"] +[cols="1,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. +| `added` +| 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. Typically documented in the Ref Guide. -| changed -| For changes to existing functionality that alter current behavior. -| Modifying an existing default behavior, updating an internal dependency, or refactoring a core algorithm. +| `changed` +| For improvements; not opt-in. +| Modifying behavior or performance of existing requests/configuration. -| deprecated -| For features or APIs that are slated for removal in future releases. -| Marking an old configuration option or an old method as deprecated. +| `fixed` +| For improvements that are deemed to have fixed buggy behavior. +| Fixing a `NullPointerException`, correcting data corruption issues, or resolving UI glitches. -| removed -| For features or APIs that have been completely removed from the codebase. -| Deleting a feature that was previously marked as deprecated. +| `deprecated` +| For marking things deprecated. +| Declaring a configuration option, class, or API endpoint as deprecated ahead of a future removal. -| fixed -| For any bug fixes or corrections to unintended behavior. -| Fixing a `NullPointerException`, correcting data corruption issues, or resolving UI glitches. +| `removed` +| For code removed. +| Removing a previously deprecated parameter, class, or legacy module. + +| `dependency_update` +| For updates to dependencies. +| Bumping third-party library versions (e.g., Lucene, Jetty, Jackson). -| security -| For vulnerabilities, security patches, or hardening improvements. -| Fixing a dependency vulnerability, adding encryption, or tightening access controls. +| `other` +| For anything else, like large/significant refactorings, build changes, test infrastructure, or documentation. +| Most such changes are too small/minor to bother with a changelog entry. Review Comment: this section has 2 columns -- description then examples. The information on this row for "other" isn't organized this way but could be easily. Basically "for anything else" is the description (adding the "Most such changes are too small/minor to bother with a changelog entry." to that part as well if it can fit, and then the examples obviously in the next column. -- 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]
