Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adjust change log entries, and update HACKING.md to match #1159

Merged
merged 9 commits into from
Mar 26, 2024

Conversation

tonyandrewmeyer
Copy link
Contributor

Minor adjustments to the way that we record changes:

  • Add more structure to CHANGES: group changes by the same types of groups as in our conventional commit messages (but with full words rather than abbreviations), and add the GitHub PR number that introduced the change
  • Include all non-internal changes in CHANGES
  • Remove "New in" notes from the API documentation (we want everyone to regularly update to the latest version, not pick a version that has whatever they need, and work hard to make this as easy as possible)
  • Update HACKING to reflect these process changes

These changes are backported to ops 2.7, which is where the CHANGES file started.

@tonyandrewmeyer tonyandrewmeyer marked this pull request as ready for review March 22, 2024 02:22
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for these updates. Just a couple of minor suggestions for CHANGES.md formatting.

CHANGES.md Outdated Show resolved Hide resolved
CHANGES.md Outdated Show resolved Hide resolved
CHANGES.md Show resolved Hide resolved
@tonyandrewmeyer tonyandrewmeyer merged commit d4eb977 into canonical:main Mar 26, 2024
28 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the changelog-changes branch March 26, 2024 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants