-
Notifications
You must be signed in to change notification settings - Fork 74
Documenting your changes
All user-visible Detect changes should be added (by the developer) to the release notes page that is part of the project source (docs/templates/content/90-releasenotes.ftl) under one of the following headers:
- New features (new capabilities)
- Changed features (changes to existing capabilities)
- Resolved issues (bug fixes)
Each release note under Resolved issues must be preceded by a JIRA ticket key in parentheses. Release notes under New features and Changed features should not be preceded by JIRA ticket keys. Recent release notes provide abundant examples.
New and changed features should almost certainly also involve a change elsewhere in the documentation (again, in the project source). For a changed feature, if the documentation doesn't already discuss the behavior you have changed, it probably should, and now would be a good time to add add that documentation. This is particularly true on the package manager pages under docs/templates/content/advanced/package-managers.
Changes to property behavior should be reflected in property descriptions in DetectProperties.java. Changes to package manager (detector) behavior should usually result in a change to the page dedicated to that package manager under docs/templates/content/advanced/package-managers.