Skip to content

Commit 5574803

Browse files
committed
docs: update document for major release guide
1 parent fb8dee3 commit 5574803

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ Describe what this pull request changes, and why. Include implications for peopl
77
- [ ] 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.
88
- [ ] 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).
99
- [ ] 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.
10+
- [ ] Verify intended release version at https://github.com/semantic-release/semantic-release#how-does-it-work
11+
12+
**For Major Release Only**
13+
- [ ] Update dependency/peer dependency repo to support the breaking change
14+
- [ ] https://github.com/openedx/frontend-component-footer
15+
- Example: https://github.com/openedx/frontend-component-footer/pull/241
16+
- [ ] https://github.com/openedx/frontend-component-header
17+
- Example: https://github.com/openedx/frontend-component-header/pull/275
18+
- [ ] https://github.com/edx/frontend-component-footer-edx
19+
- Example: https://github.com/edx/frontend-component-footer-edx/pull/208
20+
- [ ] https://github.com/edx/frontend-component-header-edx
21+
1. [ ] update `@edx/frontend-enterprise-catalog-search`, `@edx/frontend-enterprise-logistration`, `@edx/frontend-enterprise-utils` to use the same peer dependency
22+
- Example: https://github.com/openedx/frontend-enterprise/pull/278
23+
2. [ ] upgrade the release package to `frontend-component-header-edx`
24+
- Example: ....
1025

1126
**Post merge:**
1227

0 commit comments

Comments
 (0)