dsmiley commented on code in PR #4413:
URL: https://github.com/apache/solr/pull/4413#discussion_r3221189339


##########
dev-tools/scripts/README.md:
##########
@@ -182,6 +182,28 @@ Each YAML file complies with the schema outlined in 
`dev-docs/changelog.adoc`.
     # Default behavior
     python3 dev-tools/scripts/changes2logchange.py solr/CHANGES.txt
 
+### logchange.py
+
+Handles changelog git operations for each release candidate and the final
+post-vote forward-porting to other branches. Integrated into the Release Wizard
+but can also be run standalone. See `dev-docs/changelog.adoc` section 5.4 for 
details.

Review Comment:
   IMO the level of detail in this README covering all these scripts should 
only be a basic paragraph -- this lead paragraph is good.  Details (how to 
invoke) are more likely to get out of date and we can expect a reader to simply 
go to the script for such.
   
   `section 5.4` reference is too much detail; will get out of sync



##########
dev-tools/scripts/README.md:
##########
@@ -182,6 +182,28 @@ Each YAML file complies with the schema outlined in 
`dev-docs/changelog.adoc`.
     # Default behavior
     python3 dev-tools/scripts/changes2logchange.py solr/CHANGES.txt
 
+### logchange.py
+
+Handles changelog git operations for each release candidate and the final
+post-vote forward-porting to other branches. Integrated into the Release Wizard
+but can also be run standalone. See `dev-docs/changelog.adoc` section 5.4 for 
details.

Review Comment:
   I see no reference to `changelogRelease.py` -- strange



-- 
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]

Reply via email to