Richard Zowalla created OPENNLP-1765:
----------------------------------------
Summary: Improve Release Documentation: Rebase Instead of Squash,
Clarify Voting Email Format, and Suggest GitHub Release Creation
Key: OPENNLP-1765
URL: https://issues.apache.org/jira/browse/OPENNLP-1765
Project: OpenNLP
Issue Type: Task
Components: Documentation
Reporter: Richard Zowalla
Assignee: Richard Zowalla
The current release documentation could be improved to prevent common mistakes
and streamline the release process. The following updates should be made:
# *Avoid Squashing Release Commits*
** Add a clear instruction to *not squash* release commits when merging GitHub
pull requests related to releases.
** Instead, contributors should use *rebase* to preserve the individual
commits, which are important for tracking changes and debugging.
# *Clarify Voting Email Requirements*
** Emphasize that after a successful vote, a *new email* must be sent to the
mailing list.
** This email should clearly include a [{{{}RESULT]{}}} header to indicate the
outcome of the vote.
** This helps with visibility and proper record-keeping within the community /
list server and is common ASF practice.
# *Suggest Creating a GitHub Release*
** Add a hint or recommendation to create a *GitHub Release* after a
successful merge.
** This allows tools like *Dependabot* and *Renovate* to detect new versions
and release notes, improving downstream dependency updates.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
