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

chore: enhance PR template #1706

Merged
merged 18 commits into from Dec 19, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
79 changes: 34 additions & 45 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,3 +1,5 @@
_Note: Please transform `- [ ]` into `- (NA)` in the description when things are not applicable_
louismaximepiton marked this conversation as resolved.
Show resolved Hide resolved

### Related issues

<!-- Please link any related issues here. -->
Expand All @@ -24,66 +26,53 @@

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

* https://deploy-preview-{your pr number}--boosted.netlify.app/
* https://deploy-preview-{your_pr_number}--boosted.netlify.app/

### 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! -->

#### Contribution

- [ ] I have read the [contributing guidelines](https://github.com/Orange-OpenSource/Orange-Boosted-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
- [ ] My change introduces changes to the migration guide
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] All new and existing tests passed

<!------------------------->
<!-- /!\ Core Team Only -->
<!------------------------->
#### Accessibility

<!-- Uncomment the following for a feature DoD -->
- [ ] My change follows accessibility good practices; I have at least run axe

<!--
### Development

- [ ] Should match specs (eg. either the Web UI Kit or any pattern from the WAI — or both…)
- [ ] Docs added:
- including the "Sass" part using `scss-docs` shortcode
- in /about/overview/#custom-components if it is a new Orange custom component
- in /getting-started/introduction/#components if it is a new Orange custom component that requires JavaScript (and Popper)
- in /customize/overview#csps-and-embedded-svgs if it is a new Orange custom component that includes embedded SVGs in our CSS
- in /forms/validation/?#supported-elements if it is a new Orange custom component that is a form control
- in /forms/overview/ if it is a new Orange custom component that is a form control
- [ ] (Optional) If this feature is a new component, it probably must appear in Storybook
- [ ] Check (and fix) RTL version
- [ ] Run linters
- [ ] Run compilers
- [ ] Tests added for JS-side
- [ ] Run tests
- [ ] Manually run BrowserStack test
- [ ] Manually run Percy test
- [ ] Cross-browser test:
- [ ] Chrome
- [ ] Firefox (including ESR)
- [ ] Edge
- [ ] Safari
- [ ] iOS Safari
- [ ] Chrome & Firefox on Android
- [ ] Responsive tests: desktop and small screens
- [ ] Clean up the branch using `rebase -i`
- [ ] Commited with `feat(…): …` message
- [ ] Mention it in Migration Guide (if `back-from-v4`): renamed variables, changes in markup requirement, etc.

### Reviews
#### Design
julien-deramond marked this conversation as resolved.
Show resolved Hide resolved

- [ ] My change respects the design guidelines defined in [Orange Design System](https://system.design.orange.com/0c1af118d/p/8118d1-web)
- [ ] My change is compatible with responsive display
louismaximepiton marked this conversation as resolved.
Show resolved Hide resolved

#### Development

- [ ] My change follows the [developer guide](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Developer-guide)
- [ ] I have added JavaScript unit tests to cover my changes

#### Documentation

- [ ] My change introduces changes to the documentation and/or I have updated the documentation accordingly

### Checklist (for Core Team only)

- [ ] My change introduces changes to the migration guide
- [ ] My new component is added in Storybook
- [ ] My new component is compatible with RTL
- [ ] Manually run [BrowserStack tests](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/actions/workflows/browserstack.yml)
- [ ] Manually test browser compatibility with BrowserStack (Chrome >= 60, Firefox >= 60 (+ ESR), Edge, Safari >= 12, iOS Safari, Chrome & Firefox on Android)
- [ ] Code review
louismaximepiton marked this conversation as resolved.
Show resolved Hide resolved
- [ ] A11y review
- [ ] Design review
-->
- [ ] A11y review
julien-deramond marked this conversation as resolved.
Show resolved Hide resolved

#### After the merge

- [ ] Manually launch [Percy tests](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/actions/workflows/percy.yml)

<!------------------------>
<!-- /!\ Core Team Only -->
<!------------------------>

<!-- Uncomment the following for a release DoD -->

Expand Down