-
Notifications
You must be signed in to change notification settings - Fork 58
Adding new PR templates #2937
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
Merged
Merged
Adding new PR templates #2937
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d4666a9
Adding new PR templates
louismaximepiton b3073f6
Fixes after AI review
louismaximepiton 458b1d6
.
louismaximepiton 6792b3a
Merge remote-tracking branch 'origin/main' into main-lmp-update-pr-te…
louismaximepiton 325746b
fix(review)
louismaximepiton 6d2dc9a
Add the release banner
louismaximepiton 4af0b7d
Don't forget to check storybook
louismaximepiton fb93501
Merge branch 'main' into main-lmp-update-pr-template
louismaximepiton e21b675
Update .github/PULL_REQUEST_TEMPLATE/ouds-release-template.md
louismaximepiton 19106f6
Merge branch 'main' into main-lmp-update-pr-template
vprothais File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,137 +1,7 @@ | ||
| _Note: Please transform `- [ ]` into `- (NA)` in the description when things are not applicable_ | ||
|
|
||
| ### Related issues | ||
|
|
||
| <!-- Please link any related issues here. --> | ||
|
|
||
| ### Description | ||
|
|
||
| <!-- Describe your changes in detail --> | ||
|
|
||
| ### Motivation & Context | ||
|
|
||
| <!-- Why is this change required? What problem does it solve? --> | ||
|
|
||
| ### Types of change | ||
|
|
||
| <!-- What types of changes do your code introduce? --> | ||
| <!-- Please remove the unused items in the list --> | ||
|
|
||
| - Bug fix (non-breaking 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) | ||
|
|
||
| ### Live previews | ||
|
|
||
| <!-- Please add direct links where your modifications can be seen in the documentation --> | ||
|
|
||
| - <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) | ||
|
|
||
| #### Accessibility | ||
|
|
||
| - [ ] My change follows accessibility good practices; I have at least run axe | ||
|
|
||
| #### Design | ||
|
|
||
| - [ ] My change respects the design guidelines defined in [Orange Design System](https://oran.ge/dsweb) | ||
| - [ ] My change is compatible with a responsive display | ||
|
|
||
| #### 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 | ||
| - [ ] I have added SCSS 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 well displayed in [Storybook](https://deploy-preview-{your_pr_number}--boosted.netlify.app/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 | ||
| - [ ] Design review | ||
| - [ ] A11y review | ||
|
|
||
| #### 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 --> | ||
|
|
||
| <!-- | ||
| - [ ] Run linters; | ||
| - [ ] Run compilers; | ||
| - [ ] Run tests; | ||
| - [ ] Check documentation site: examples and contents; | ||
| - [ ] Test cross-browser compatibility locally and with [BrowserStack](https://www.browserstack.com/): | ||
| - Firefox ESR | ||
| - IE11 (v4 only) | ||
| - Latest Edge, Chrome, Firefox, Safari | ||
| - iOS Safari | ||
| - Chrome & Firefox on Android | ||
| - [ ] Including RTL mode; | ||
| - [ ] Ask for reviews and accessibility testing; | ||
| - [ ] [sync with Bootstrap](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Syncing-with-Bootstrap)'s release and probably wait for it; | ||
| - [ ] `npm run release-version $current_version $next_version` to bump version number | ||
| - then, if bumping a minor or major version: | ||
| - [ ] Manually change `version_short` in `package.json` | ||
| - [ ] Add docs version to `site/data/docs-versions.yml` | ||
| - [ ] Manually change `docs_version` in `hugo.yml` and other references to the previous version | ||
| - [ ] Update redirects in docs frontmatter (`site/content/docs/_index.html`?) | ||
| - [ ] Move `site/content/docs/5.x` to `site/content/docs/5.x+1` | ||
| - [ ] Increment `site/static/docs/{version}` version | ||
| - [ ] Increment version in `nuget/boosted.nuspec` | ||
| - [ ] (Major version) Manually update the version in `nuget/boosted.nuspec` and `nuget/boosted.sass.nuspec` | ||
| - check wrong matches in `CHANGELOG.md`, and maybe `site/content/docs/<version>/migration.md` | ||
| - :warning: check the `package-lock.json` and `package.json` content, only "boosted" should have its version changed! | ||
| - :warning: `site/content/docs/5.1/**/*.md` should not always be modified | ||
| - [ ] if the year changed recently, happy new year :tada: but please change © year in `.scss` main files (reboot, grid, utilities, and main file) as well as in `NOTICE.txt`. | ||
| - [ ] `npm run release` to compile dist, build Storybook, update SRI hashes in doc, and package the release | ||
| - [ ] Prepare changelog: | ||
| - install [Conventionnal Changelog](https://github.com/conventional-changelog/conventional-changelog) and `conventional-changelog-cli` globally | ||
| - run `conventional-changelog -p angular -i CHANGELOG.md -s` | ||
| - and probably maintain [a ship list (e.g. for v4.4.0)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/issues/226) | ||
| - [ ] Commit and push `dist` with a `chore(release)` commit message | ||
| - [ ] Manually run BrowserStack test | ||
| - [ ] Manually run Percy test | ||
| - [ ] Merge (on `v4-dev` or `main`) | ||
| - [ ] Tag your version, and push your tag | ||
| - [ ] Pack and publish | ||
| - `npm pack` | ||
| - if you are already logged in to NPM (with a personal account, for example), [you'd better use a repository scoped `.npmrc` file](https://stackoverflow.com/questions/30114166/how-to-have-multiple-npm-users-set-up-locally) | ||
| - Publish: | ||
| - if you're releasing a pre-release, use `--tag`, e.g. for v5-alpha1 `npm publish boosted-5.0.0-alpha1.tgz --tag next` | ||
| - (v4 only) `npm publish --tag v4.x.y` (if you forgot and v4 becomes the latest version on NPM, you can run `npm dist-tag add [email protected] latest to fix it) | ||
| - (v5 only) `npm publish` | ||
| - [ ] check release on [NPM](https://www.npmjs.com/package/boosted), [Nuget](https://www.nuget.org/packages/boosted/), [Packagist](https://packagist.org/packages/orange-opensource/orange-boosted-bootstrap)… | ||
| - [ ] publish documentation on `gh-pages`: | ||
| - [ ] copy `../_site` to the `gh-pages` branch (don't forget to update Storybook as well) | ||
| - [ ] check every `index.html` used as redirections to redirect to the new release | ||
| - [ ] when bumping minor version: ensure `dist` URLs in examples' HTML has changed | ||
| - [ ] double-check everything before pushing, starting by searching for forgotten old version number occurrences | ||
| - [ ] make an announcement in [GitHub Discussions](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/discussions/categories/announcements) (+ pin the new GH Discussion) | ||
| - [ ] [create a GitHub release](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/new): | ||
| - attach the zip file | ||
| - paste the CHANGELOG / Ship list in the release's description | ||
| - [ ] make an announcement on internal communication channels :tada: | ||
| - [ ] [publish on Nuget](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Generate-NuGet-packages) | ||
| --> | ||
| Click the `Preview` tab and select a PR template: | ||
| - **Boosted**: | ||
| - [Contribute to Boosted](?expand=1&template=boosted-contribution-template.md) | ||
| - [Release Boosted](?expand=1&template=boosted-release-template.md) (Core team only) | ||
| - **OUDS Web**: | ||
| - [Contribute to OUDS Web](?expand=1&template=ouds-contribution-template.md) | ||
| - [Release OUDS Web](?expand=1&template=ouds-release-template.md) (Core team only) |
72 changes: 72 additions & 0 deletions
72
.github/PULL_REQUEST_TEMPLATE/boosted-contribution-template.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| _Note: Please transform `- [ ]` into `- (NA)` in the description when things are not applicable_ | ||
|
|
||
| ### Related issues | ||
|
|
||
| <!-- Please link any related issues here. --> | ||
|
|
||
| ### Description | ||
|
|
||
| <!-- Describe your changes in detail --> | ||
|
|
||
| ### Motivation & Context | ||
|
|
||
| <!-- Why is this change required? What problem does it solve? --> | ||
|
|
||
| ### Types of change | ||
|
|
||
| <!-- What types of changes do your code introduce? --> | ||
| <!-- Please remove the unused items in the list --> | ||
|
|
||
| - Bug fix (non-breaking 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) | ||
|
|
||
| ### Live previews | ||
|
|
||
| <!-- Please add direct links where your modifications can be seen in the documentation --> | ||
|
|
||
| - <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) | ||
|
|
||
| #### Accessibility | ||
|
|
||
| - [ ] My change follows accessibility good practices; I have at least run axe | ||
|
|
||
| #### Design | ||
|
|
||
| - [ ] My change respects the design guidelines defined in [Orange Design System](https://oran.ge/dsweb) | ||
| - [ ] My change is compatible with a responsive display | ||
|
|
||
| #### 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 | ||
| - [ ] I have added SCSS 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 well displayed in [Storybook](https://deploy-preview-{your_pr_number}--boosted.netlify.app/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 | ||
| - [ ] Design review | ||
| - [ ] A11y review | ||
|
|
||
| #### After the merge | ||
|
|
||
| - [ ] Manually launch [Percy tests](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/actions/workflows/percy.yml) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| ## Release v | ||
|
|
||
| - [ ] [sync with Bootstrap](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Syncing-with-Bootstrap)'s release and probably wait for it; | ||
| - [ ] `npm run release-version $current_version $next_version` to bump version number | ||
| - then, if bumping a minor or major version: | ||
| - [ ] Manually change `version_short` in `package.json` | ||
| - [ ] Add docs version to `site/data/docs-versions.yml` | ||
| - [ ] Manually change `docs_version` in `hugo.yml` and other references to the previous version | ||
MaxLardenois marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [ ] Update redirects in docs frontmatter (`site/content/docs/_index.html`?) | ||
| - [ ] Move `site/content/docs/5.x` to `site/content/docs/5.x+1` | ||
| - [ ] Increment `site/static/docs/{version}` version | ||
| - [ ] (Major version) Manually update the version in `nuget/boosted.nuspec` and `nuget/boosted.sass.nuspec` | ||
| - check wrong matches in `CHANGELOG.md`, and maybe `site/content/docs/<version>/migration.md` | ||
| - :warning: check the `package-lock.json` and `package.json` content, only "boosted" should have its version changed! | ||
| - :warning: `site/content/docs/5.1/**/*.md` should not always be modified | ||
| - [ ] if the year changed recently, happy new year :tada: but please change © year in `.scss` main files (reboot, grid, utilities, and main file) as well as in `NOTICE.txt`. | ||
| - [ ] `npm run release` to compile dist, build Storybook, update SRI hashes in doc, and package the release | ||
| - [ ] Prepare changelog: | ||
| - install [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) and `conventional-changelog-cli` globally | ||
| - run `conventional-changelog -p angular -i CHANGELOG.md -s` | ||
| - and probably maintain [a ship list (e.g. for v4.4.0)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/issues/226) | ||
| - [ ] Commit and push `dist` with a `chore(release)` commit message | ||
| - [ ] Manually run BrowserStack test | ||
| - [ ] Manually run Percy test | ||
| - [ ] Merge (on `v4-dev` or `main`) | ||
| - [ ] Tag your version, and push your tag | ||
| - [ ] Pack and publish | ||
| - `npm pack` | ||
| - if you are already logged in to NPM (with a personal account, for example), [you'd better use a repository scoped `.npmrc` file](https://stackoverflow.com/questions/30114166/how-to-have-multiple-npm-users-set-up-locally) | ||
| - Publish: | ||
| - if you're releasing a pre-release, use `--tag`, e.g. for v5-alpha1 `npm publish boosted-5.0.0-alpha1.tgz --tag next` | ||
| - (v4 only) `npm publish --tag v4.x.y` (if you forgot and v4 becomes the latest version on NPM, you can run `npm dist-tag add [email protected] latest to fix it) | ||
| - (v5 only) `npm publish` | ||
| - [ ] check release on [NPM](https://www.npmjs.com/package/boosted), [Nuget](https://www.nuget.org/packages/boosted/), [Packagist](https://packagist.org/packages/orange-opensource/orange-boosted-bootstrap)… | ||
| - [ ] publish documentation on `gh-pages`: | ||
| - [ ] copy `../_site` to the `gh-pages` branch (don't forget to update Storybook as well) | ||
| - [ ] check every `index.html` used as redirections to redirect to the new release | ||
| - [ ] when bumping minor version: ensure `dist` URLs in examples' HTML has changed | ||
| - [ ] double-check everything before pushing, starting by searching for forgotten old version number occurrences | ||
| - [ ] make an announcement in [GitHub Discussions](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/discussions/categories/announcements) (+ pin the new GH Discussion) | ||
| - [ ] [create a GitHub release](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/new): | ||
| - attach the zip file | ||
| - paste the CHANGELOG / Ship list in the release's description | ||
| - [ ] make an announcement on internal communication channels :tada: | ||
| - [ ] [publish on Nuget](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Generate-NuGet-packages) | ||
53 changes: 53 additions & 0 deletions
53
.github/PULL_REQUEST_TEMPLATE/ouds-contribution-template.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| ### Types of change | ||
|
|
||
| - [ ] Non-breaking change | ||
| - [ ] Breaking change (fix or feature that would change existing functionality and usage) | ||
|
|
||
| ### Related issues | ||
|
|
||
| Closes # | ||
|
|
||
| ### Context & Motivation | ||
|
|
||
| <!-- Describe the actual behavior (and how to reproduce it). --> | ||
|
|
||
| ### Description | ||
|
|
||
| <!-- Describe your changes in detail --> | ||
|
|
||
| ### Checklists | ||
|
|
||
| <!-- 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/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/.github/CONTRIBUTING.md) | ||
| - [ ] My change follows the [developer guide](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Developer-guide) | ||
| - [ ] My change pass all tests | ||
| - [ ] My change is compatible with a responsive display | ||
| - [ ] I have added tests (Javascript unit test or visual) to cover my changes | ||
| - [ ] My change introduces changes to the documentation that I have updated accordingly | ||
| - [ ] Title and DOM structure is correct | ||
| - [ ] Links have been updated (title changes impact links) | ||
| - [ ] CSS for the documentation | ||
| - [ ] I have checked all states and combinations of the component with my change | ||
| - [ ] I have checked all the impacts for the other components and core behavior (grid, reboot, utilities) | ||
|
|
||
| ### Checklist (for Core Team only) | ||
|
|
||
| - [ ] The changes need to be in the migration guide | ||
| - [ ] The changes are well displayed in [Storybook](https://deploy-preview-{your_pr_number}--boosted.netlify.app/storybook) (be careful if example order has changed for DSM) | ||
| - [ ] The changes are compatible with RTL | ||
| - [ ] Manually test browser compatibility with BrowserStack (Chrome 120, Firefox 121, Edge 120, Safari 15.6, iOS Safari, Chrome & Firefox on Android) | ||
|
|
||
| ### Progression (for Core Team only) | ||
|
|
||
| - [ ] Code review | ||
| - [ ] Design review | ||
| - [ ] A11y review | ||
| - [ ] Commit on `ouds/main` following [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) | ||
|
|
||
| ### Live previews | ||
|
|
||
| <!-- Please add direct links where your modifications can be seen in the documentation --> | ||
|
|
||
| - <https://deploy-preview-{your_pr_number}--boosted.netlify.app/> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Release v" ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought it as a placeholder, it's to avoid looking at a previous merge how it was done.