Create release related rules for the Beman Standard

Beman Project Development
1

Hello all,

After discussions from Update the Beman Standard: remove changelog by neatudarius · Pull Request #103 · bemanproject/beman · GitHub, we removed the Changelog file and we want to add some rules related to release notes, where we can also incorporate a history of library status values.

Starting from @Jeff-Garland suggestions (Update the Beman Standard: remove changelog by neatudarius · Pull Request #103 · bemanproject/beman · GitHub) and what @bretbrownjr already implemented for first releases in exemplar (Releases · bemanproject/exemplar · GitHub), I extracted a RELEASE_NOTES rule in draft PR Extend the Beman Standard: add release related rules by neatudarius · Pull Request #108 · bemanproject/beman · GitHub.

Issue Add release notes rule · Issue #106 · bemanproject/beman · GitHub

Possible topics to be discussed:

  • Do we want a REQUIREMENT/RECOMMENDATION rule to say we must/should use GitHub Releases? → RELEASE_GITHUB
  • Do we want a REQUIREMENT/RECOMMENDATION rule to say we must/should have a specific content/format for release notes? → RELEASE_NOTES

CC: @leads @bretbrownjr

1 Like
2

I would prefer requiring GitHib releases since it’s simple to explain that way. We do want tagged releases provided as zips and tar balls, so we might as well just use the relevant feature.

I don’t have strong opinions about the format of release notes as long as they meet the Beman CoC. I’ll go with consensus, including “rough consensus” ( often this looks like whatever a volunteer implements and no objections from others).

1 Like
3

I agree. I think the [RELEASE_NOTES] rule could be a recommendation.

1 Like
4

Applied feedback from Bret, David and all comments from @RaduNichita on Extend the Beman Standard: add release related rules by neatudarius · Pull Request #108 · bemanproject/beman · GitHub.

Can I get a review/approval from the @leads or codeowners? We have a strict/small codeowner set for beman/ (which I think it’s OK for this repo). TLDR: The LGTM from Radu it’s not enough to merge the PR. :smiley:

1 Like
5

Thread closed. Thanks!

1 Like