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

Update release instructions #942

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Conversation

dbeatty10
Copy link
Contributor

resolves N/A

Problem

When doing a release, there are steps that aren't enumerated explicitly, like:

  • Creating a pull request with the relevant updates to the changelog
  • How to update the release notes generated in the GitHub release into the format of our changelog

Solution

  • Mention reformatting of the generated release notes
  • Link to the changelog source code for reference
  • Link to an example PR

Checklist

  • This code is associated with an issue which has been triaged and accepted for development.
  • I have read the contributing guide and understand what's expected of me
  • I have run this code in development and it appears to resolve the stated issue
  • This PR includes tests, or tests are not required/relevant for this PR
  • I have updated the README.md (if applicable)

@dbeatty10 dbeatty10 merged commit e90d648 into main Aug 28, 2024
13 checks passed
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.

1 participant