development-guidelines
development-guidelines copied to clipboard
Our default PR template makes it so that our PR's are always 1/4 in GitHub's UI
Expected Behavior
Don't display a steps UI when we are actually selecting an option.
Current Behavior
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 😅
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
Example: https://github.com/vtex-apps/store-components/pull/915
I personally like to use labels for the type of change information
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
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
I've also missed this :harold: I can formalize it in a PR 👍🏼