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

Improve changelogs #987

Open
kaylareopelle opened this issue May 14, 2024 · 1 comment
Open

Improve changelogs #987

kaylareopelle opened this issue May 14, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open

Comments

@kaylareopelle
Copy link
Contributor

It's difficult for me to trace the exact change related to a given release. I think we can make some updates to the structure of the changelog to make things more user-friendly.

Some improvements ideas:

  • Add a link to the PR(s) that caused the change
  • Use the PR title as the changelog title
  • Include a description for the change (perhaps we can have PR descriptions or content beneath a specific heading determine the description)
  • Have an overall release changelog for contrib as a whole (which PRs have been released? what gems did they impact?)
    • Maybe this looks like a tag that's easy to filter on PRs? Maybe something like this exists and I'm now aware?
@kaylareopelle kaylareopelle added help wanted Extra attention is needed documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels May 15, 2024
Copy link
Contributor

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label Jun 15, 2024
@arielvalentin arielvalentin added keep Ensures stale-bot keeps this issue/PR open and removed stale Marks an issue/PR stale labels Jun 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open
Projects
None yet
Development

No branches or pull requests

2 participants