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 GH repo PR template checklist for CHANGELOG expectations #5416

Merged
merged 2 commits into from
Aug 8, 2024

Conversation

sreuland
Copy link
Contributor

@sreuland sreuland commented Aug 8, 2024

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

per sprint retro feedback, we want to highlight keeping CHANGELOG's up to date in between releases by focusing on PR's updating it incrementally.

Why

  • Release process may not retro-actively capture all the PRs and accurate descriptions for changes that have been merged in release notes at the end.
  • The repo-wide CONTRIBUTING.md already mentions adding an entry as part of coding guidelines.

Known limitations

depends on manual recognition.

@sreuland sreuland merged commit cabbd30 into stellar:master Aug 8, 2024
23 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.

2 participants