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.

Sign up for GitHub

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

Jump to bottom

Add PR template #35079

Merged
merged 4 commits into from
Sep 23, 2022
Merged

Add PR template #35079

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84d14b9
Add PR template
mdo Sep 29, 2021
1076458
Update PULL_REQUEST_TEMPLATE.md
XhmikosR Dec 22, 2021
f0d9f33
add previews section
GeoSot Sep 22, 2022
2ddb8d6
Update PULL_REQUEST_TEMPLATE.md
mdo Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
### Description

<!-- Describe your changes in detail -->

### Motivation & Context

<!-- Why is this change required? What problem does it solve? -->

### Types of changes
Copy link
Member

Choose a reason for hiding this comment

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

There is maybe an unwanted side effect with checkboxes here.
Considering the PR filled this way:

Screenshot from 2021-12-30 07-37-28

It will be considered as a checklist by GitHub and will be displayed like that in the PRs list:

Screenshot from 2021-12-30 07-38-53

"7 of 10 tasks" may be troubling or frustrating and can't be fixed by the user since they are not real tasks but choices.

If you find this comment relevant, we could try another approach like that:

<!-- What types of changes does your code introduce? Uncomment the following types that apply. -->

<!-- - Bug fix (non-breaking change which fixes an issue) -->
<!-- - New feature (non-breaking change which adds functionality) -->
<!-- - Refactoring (non-breaking change) -->
<!-- - Breaking change (fix or feature that would change existing functionality) -->


<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactoring (non-breaking change)
- [ ] Breaking change (fix or feature that would change existing functionality)

### Checklist

<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] I have read the [contributing guidelines](https://github.com/twbs/bootstrap/blob/main/.github/CONTRIBUTING.md)
- [ ] My code follows the code style of the project _(using `npm run lint`)_
- [ ] My change introduces changes to the documentation
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] All new and existing tests passed


#### Live previews

<!-- Please add direct links where your modifications can be seen in the documentation -->

* https://deploy-preview-{your pr number}--twbs-bootstrap.netlify.app/


### Related issues

<!-- Please link any related issues here. -->