Skip to content

Commit

Permalink
docs: update document for major release guide
Browse files Browse the repository at this point in the history
  • Loading branch information
leangseu-edx committed Nov 2, 2022
1 parent fb8dee3 commit 5574803
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down

0 comments on commit 5574803

Please sign in to comment.