SOLR-18286: Add Changelog Types Reference to developer documentation#4530
SOLR-18286: Add Changelog Types Reference to developer documentation#4530abumarjikar wants to merge 1 commit into
Conversation
janhoy
left a comment
There was a problem hiding this comment.
I don't think we need a changelog entry for a doc change like this - it makes no sense in context of the shipped Solr tgz to mention that a developer doc has changed.
Else, this is a nice clarification, thanks.
Then a comment, not on your doc but in general about the security type. A security type would not be mutually exclusive with the other types. A change regarding a security issue would always also either be added, changed, deprecated, removed or fixed. I know it is a type recommended by https://keepachangelog.com/en/1.1.0/#how but in practice we never or rarely flag something as security until after a release?
dsmiley
left a comment
There was a problem hiding this comment.
What was the source of you writing this; did you guess? I suspect so as it doesn't have "other". See
Lines 70 to 79 in 232690c
|
|
||
| | changed | ||
| | For changes to existing functionality that alter current behavior. | ||
| | Modifying an existing default behavior, updating an internal dependency, or refactoring a core algorithm. |
There was a problem hiding this comment.
| | Modifying an existing default behavior, updating an internal dependency, or refactoring a core algorithm. | |
| | Modifying behavior or performance of existing requests/configuration. |
No: Not usually a dependency update. Not usually a refactoring. Both of those are usually "other".
| | Type | Description | When to Use (Examples) | ||
|
|
||
| | added | ||
| | For completely new features, capabilities, or opt-in functionality. |
There was a problem hiding this comment.
| | For completely new features, capabilities, or opt-in functionality. | |
| | 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.
| | For any bug fixes or corrections to unintended behavior. | ||
| | Fixing a `NullPointerException`, correcting data corruption issues, or resolving UI glitches. | ||
|
|
||
| | security |
There was a problem hiding this 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.
https://issues.apache.org/jira/browse/SOLR-18286
Description
This PR introduces a structured "Changelog Types Reference" guide to the developer documentation (dev-docs/changelog.adoc). It explicitly defines the intended use cases for each changelog classification type (added, changed, deprecated, removed, fixed, and security) to ensure consistency across community contributions and release notes.
Solution
dded an explicit AsciiDoc reference table in dev-docs/changelog.adoc categorizing each valid changelog type with its description and concrete examples.
Tests
No programmatic tests were written as this is a pure documentation update. Verified local formatting layout for the AsciiDoc table preview structure.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.