From 55748033d272a76fa6535bbb41aa65f08c6b7a95 Mon Sep 17 00:00:00 2001 From: Leangseu Kim Date: Wed, 2 Nov 2022 16:04:23 -0400 Subject: [PATCH] docs: update document for major release guide --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b2f4c4eaa..5461b9cea 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,6 +7,21 @@ Describe what this pull request changes, and why. Include implications for peopl - [ ] Consider running your code modifications in the included example app within `frontend-platform`. This can be done by running `npm start` and opening http://localhost:8080. - [ ] Consider testing your code modifications in another local micro-frontend using local aliases configured via [the `module.config.js` file in `frontend-build`](https://github.com/openedx/frontend-build#local-module-configuration-for-webpack). - [ ] Verify your commit title/body conforms to the conventional commits format (e.g., `fix`, `feat`) and is appropriate for your code change. Consider whether your code is a breaking change, and modify your commit accordingly. + - [ ] Verify intended release version at https://github.com/semantic-release/semantic-release#how-does-it-work + +**For Major Release Only** +- [ ] Update dependency/peer dependency repo to support the breaking change + - [ ] https://github.com/openedx/frontend-component-footer + - Example: https://github.com/openedx/frontend-component-footer/pull/241 + - [ ] https://github.com/openedx/frontend-component-header + - Example: https://github.com/openedx/frontend-component-header/pull/275 + - [ ] https://github.com/edx/frontend-component-footer-edx + - Example: https://github.com/edx/frontend-component-footer-edx/pull/208 + - [ ] https://github.com/edx/frontend-component-header-edx + 1. [ ] update `@edx/frontend-enterprise-catalog-search`, `@edx/frontend-enterprise-logistration`, `@edx/frontend-enterprise-utils` to use the same peer dependency + - Example: https://github.com/openedx/frontend-enterprise/pull/278 + 2. [ ] upgrade the release package to `frontend-component-header-edx` + - Example: .... **Post merge:**