Skip to content

Add reference to the MIGRATION.md file to the PR template checklist #488

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

Merged
merged 1 commit into from
Jun 8, 2023

Conversation

iangmaia
Copy link
Contributor

@iangmaia iangmaia commented Jun 2, 2023

What does it do?

  1. Fixes a small typo on the Github PR template: describe your changes under the approprioate
  2. Adds a Checklist item to remind folks to consider the implications of their changes when migrating from a previous major version.

Related PRs

Checklist before requesting a review

  • Run bundle exec rubocop to test for code style violations and recommendations
  • Add Unit Tests (aka specs/*_spec.rb) if applicable
  • Run bundle exec rspec to run the whole test suite and ensure all your tests pass
  • Make sure you added an entry in the CHANGELOG.md file to describe your changes under the approprioate existing ### subsection of the existing ## Trunk section.

Copy link
Contributor

@AliSoftware AliSoftware left a comment

Choose a reason for hiding this comment

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

LGTM! Ideally I'd love for us to configure Danger on that repo at some point to automate those checks, but until then, this is a good way to remind us about the MIGRATION.md file 👍

@iangmaia iangmaia merged commit d6b1f42 into trunk Jun 8, 2023
@iangmaia iangmaia deleted the add/pr-template-with-migration branch June 8, 2023 16:41
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