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

Doc: Update PR template checklist #12

Merged
merged 8 commits into from
Apr 27, 2022
Merged

Conversation

mariana-caetano
Copy link
Contributor

@mariana-caetano mariana-caetano commented Apr 26, 2022

What's the purpose of this pull request?

Added new items to the pull_request_template.md to help highlight the changes added in the CHANGELOG.md and Release Notes.

How does it work?

The new items intended to help users and the team identify the changes in gatsby.store and keep a pattern in the CHANGELOG.md update.

Checklist Item Before Now
CHANGELOG entry added
Added an entry in the CHANGELOG.md at the beginning of its due section. The latest version should comes first.
Added the PR number with the PR link at the entry in the CHANGELOG.md
Updated the Storybook - if applicable.
Added a label according to the PR goal - Breaking change, Enhancement, Bug or Chore.
Added the component, hook, or pathname in-between backticks (``) - If applicable. E.g., ComponentName component.
Identified the function or parameter in the PR - If applicable. E.g., useWindowDimensions hook.
For documentation changes, ping @ carolinamenezes or @ Mariana-Caetano to review and update the changes.

How to test it?

Describe the steps with bullet points. Is there any external reference, link, or example?

References

Checklist

You may erase this after checking them all ;)

  • CHANGELOG entry added

@mariana-caetano mariana-caetano added the Documentation Improvements or additions to documentation label Apr 26, 2022
@vtex-sites
Copy link

vtex-sites bot commented Apr 26, 2022

Preview is ready

This pull request generated a Preview

👀   Preview: https://preview-12--gatsby.preview.vtex.app
🔬   Go deeper by inspecting the Build Logs
📝   based on commit c5c6668

@vtex-sites
Copy link

vtex-sites bot commented Apr 26, 2022

Lighthouse Reports

Here are the Lighthouse reports of this Pull Request

Page Report
/ 📎   Access the Lighthouse report here.
/apple-magic-mouse-99988212/p 📎   Access the Lighthouse report here.
/office 📎   Access the Lighthouse report here.

CHANGELOG.md Outdated Show resolved Hide resolved
pull_request_template.md Outdated Show resolved Hide resolved
pull_request_template.md Outdated Show resolved Hide resolved
Copy link
Contributor

@filipewl filipewl left a comment

Choose a reason for hiding this comment

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

Thanks!

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- New items in the `pull_request_template.md` ([#12](https://github.com/vtex-sites/gatsby.store/pull/12))
Copy link
Contributor

Choose a reason for hiding this comment

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

Oooh, good call adding the link! Hadn't noticed GH didn't create the link automatically as it does inside issues and PRs messages. Will do the same moving forward.
😬

Copy link
Contributor Author

@mariana-caetano mariana-caetano Apr 26, 2022

Choose a reason for hiding this comment

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

Yes! 😃 I will add this to the checklist as well!


- PR description
- [ ] Updated the Storybook - *if applicable*.
- [ ] Added a label according to the PR goal - `Breaking change`, `Enhancement`, `Bug` or `Chore`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Added these 2 missing labels to the repo:
CleanShot 2022-04-26 at 18 18 00@2x

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, @filipewl!

@filipewl
Copy link
Contributor

filipewl commented Apr 26, 2022

For some unknown reason, the last commit didn't seem to trigger our WebOps checks on GH... You may need to push an empty commit to trigger a new attempt (e.g. git commit -m 'Trigger CI with an empty commit' --allow-empty --no-verify && git push).

CleanShot 2022-04-26 at 18 36 16@2x


Edit: the new commit has started a new attempt already!

Copy link
Contributor

@heitorado heitorado left a comment

Choose a reason for hiding this comment

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

Looking good :)

@mariana-caetano mariana-caetano merged commit c5c6668 into main Apr 27, 2022
@mariana-caetano mariana-caetano deleted the update-pr-checklist branch April 27, 2022 13:11
@lucasfp13 lucasfp13 mentioned this pull request Apr 29, 2022
5 tasks
@Gmantiqueira Gmantiqueira mentioned this pull request Apr 29, 2022
Closed
7 tasks
@lucasfp13 lucasfp13 mentioned this pull request Apr 30, 2022
5 tasks
@filipewl filipewl mentioned this pull request May 2, 2022
@tlgimenes tlgimenes mentioned this pull request May 2, 2022
@viniagostini viniagostini mentioned this pull request May 3, 2022
7 tasks
@hellofanny hellofanny mentioned this pull request Jun 17, 2022
8 tasks
@Gmantiqueira Gmantiqueira mentioned this pull request Jun 20, 2022
8 tasks
@lucasfp13 lucasfp13 mentioned this pull request Jun 23, 2022
6 tasks
@tlgimenes tlgimenes mentioned this pull request Jun 25, 2022
8 tasks
@hellofanny hellofanny mentioned this pull request Jun 28, 2022
8 tasks
@tlgimenes tlgimenes mentioned this pull request Jun 29, 2022
8 tasks
This was referenced Jun 29, 2022
@nicacioliveira nicacioliveira mentioned this pull request Jul 11, 2022
8 tasks
@ArthurTriis1 ArthurTriis1 mentioned this pull request Jul 11, 2022
8 tasks
@eduardoformiga eduardoformiga mentioned this pull request Jul 11, 2022
8 tasks
@victorhmp victorhmp mentioned this pull request Jul 22, 2022
8 tasks
@lucasfp13 lucasfp13 mentioned this pull request Jul 22, 2022
6 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants