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

Our default PR template makes it so that our PR's are always 1/4 in GitHub's UI #5

Open
tibuurcio opened this issue Jan 28, 2021 · 5 comments
Assignees

Comments

@tibuurcio
Copy link

tibuurcio commented Jan 28, 2021

Expected Behavior

Don't display a steps UI when we are actually selecting an option.

Current Behavior

image

Possible Solution

Maybe we could use another Markdown syntax in order to not trigger this UI by GitHub?
I found another template style searching for it on Slack (thread)

Pinging @pedromtec since it was his response on the thread.

Context

It looks like all steps from our PR's are not concluded and if we want to use this feature on the future it would be nice to have another UI for selecting an option 😅
image

@klzns
Copy link

klzns commented Jan 28, 2021

Store Framework team is currently using this as a PR template: https://github.com/vtex-apps/react-app-template/blob/master/.github/PULL_REQUEST_TEMPLATE.md

image

Example: vtex-apps/store-components#915

@ericreis
Copy link

ericreis commented Feb 1, 2021

I personally like to use labels for the type of change information

@brunojdo
Copy link
Contributor

Hi! I totally lost this issue. Thanks for bringing this up @tibuurcio

I'm aligned with this issue. Let's move forward and formalize a proposal in a PR. Can you do it this @tibuurcio?
I would consider the suggestion of @ericreis about leveraging labels

@viniciuslagedo
Copy link

viniciuslagedo commented Aug 31, 2022

Here in Identity Team we add a checklist to the PR Template to prevent forgot some essential stuff. It can be very specific for each project, but it's just an idea.

Example:

Checklist

  • I have added the necessary documentation (if appropriate)
  • I have added the necessary localization
  • I have increased the tests
  • I have made the necessary non-functional tests
  • All tests are passing
  • I have updated the changelog

@tibuurcio
Copy link
Author

I've also missed this :harold:
I can formalize it in a PR 👍🏼

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

No branches or pull requests

10 participants