From 11752c00724c4d9a9eb6fe8ea579e624bdacc02d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20D=C3=A9ramond?= <julien.deramond@orange.com>
Date: Tue, 13 Sep 2022 10:53:52 +0200
Subject: [PATCH] chore: add a PR template (#1007)

---
 .github/PULL_REQUEST_TEMPLATE.md | 145 +++++++++++++++++++++++++++++++
 1 file changed, 145 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000..9f23a53740
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,145 @@
+### 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 does you code introduce? -->
+<!-- Please remove the unused items in the list -->
+
+- Bug fix (non-breaking which fixes an issues)
+- 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}--twbs-bootstrap.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! -->
+
+- [ ] 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
+- [ ] I have updated the documentation accordingly
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed
+
+<!------------------------->
+<!-- /!\ Core Team Only -->
+<!------------------------->
+
+<!-- Uncomment the following for a feature DoD -->
+
+<!--
+### 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
+- [ ] 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
+
+- [ ] Code review
+- [ ] A11y review
+- [ ] Design review
+-->
+
+
+
+<!-- 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 `config.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`
+    - [ ] Ensure Algolia indexes new release content ([probably requires a PR](https://github.com/algolia/docsearch-configs/pull/1954))
+    - [ ] (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 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, 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 (eg 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
+- [ ] [create a GitHub release](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/new):
+  - attach zip file
+  - paste CHANGELOG / Ship list in the release's description
+- [ ] Pack and publish
+  - `npm pack`
+  - if you are already logged in NPM (with a personnal 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`, eg 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 boosted@5.x.y latest to fix it)
+    - (v5 only) `npm publish`
+- [ ] [publish on Nuget](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Generate-NuGet-packages)
+- [ ] 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
+  - [ ] check every `index.html` used as redirections to be redirecting 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 occurences
+- [ ] make an announcement in Plazza :tada:
+-->