Skip to content

Commit 1dfadea

Browse files
author
Illia Obukhau
authored
chore(web-widgets): update pr template (#341)
2 parents 14b542a + ba19de3 commit 1dfadea

File tree

1 file changed

+67
-22
lines changed

1 file changed

+67
-22
lines changed

.github/pull_request_template.md

Lines changed: 67 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,76 @@
1-
### Description
1+
<!--
2+
IMPORTANT: Please read and follow instructions below on how to
3+
open and submit your pull request.
24
3-
<!--- Describe your changes in detail -->
5+
REQUIRED STEPS:
6+
1. Specify correct pull request type.
7+
2. Write meaningful description.
8+
3. Run `pnpm lint` and `pnpm test` in packages you changed and make sure they have no errors.
9+
4. Add new tests (if needed) to cover new functionality.
10+
5. Read checklist below.
411
5-
### Pull request checklist
12+
CHECKLIST:
13+
- Do you have a JIRA story for your pull request?
14+
- If yes, please format the PR title to match the `[XX-000]: description` pattern.
15+
- If no, please write your PR title using conventional commit rules.
16+
- Does your change require a new version of the widget/module?
17+
- If yes, run `pnpm -w changelog` or update the `CHANGELOG.md` and bump the version manually.
18+
- If no, ignore.
19+
- Do you have related PRs in other Mendix repositories?
20+
- If yes, please link all related pull requests in the description.
21+
- If no, ignore.
22+
- Does your change touch XML, or is it a new feature or behavior?
23+
- If yes, if necessary, please create a PR with updates in the documentation (https://github.com/mendix/docs).
24+
- If no, ignore.
25+
- Is your change a bug fix or a new feature?
26+
- If yes, please add a description (last section in the template) of what should be tested and what steps are needed to test it.
27+
- If no, ignore.
28+
-->
629

7-
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
8-
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
30+
<!--
31+
What type of changes does your PR introduce?
32+
Uncomment relevant sections below by removing `<!--` at the beginning of the line.
33+
-->
934

10-
- [ ] All new and existing tests passed
11-
- [ ] I run `lint` command locally and it doesn’t give errors
12-
- [ ] PR title properly formatted `[XX-000]: description`
13-
- [ ] Added record to packages' CHANGELOG.md
14-
- [ ] Bumped package version in `package.json` and `package.xml`
15-
- [ ] Added a link to related project PRs (atlas, pluggable-widgets-tools, testProject, etc.) (optional)
16-
- [ ] Created docs PR to [mendix/docs](https://github.com/mendix/docs.git) and added a link (optional)
35+
### **Pull request type**
1736

18-
### Pull request type
37+
<!-- No code changes (changes to documentation, CI, metadata, etc.)
38+
<!---->
1939

20-
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
40+
<!-- Dependency changes (any modification to dependencies in `package.json`)
41+
<!---->
2142

22-
- [ ] No code changes (changes to documentation, CI, metadata, etc)
23-
- [ ] Dependency changes (any modification to dependencies in `package.json`)
24-
- [ ] Bug fix (non-breaking change which fixes an issue)
25-
- [ ] New feature (non-breaking change which adds functionality)
26-
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
27-
- [ ] Test related change (New E2E test, test automation, etc.)
43+
<!-- Refactoring (e.g. file rename, variable rename, etc.)
44+
<!---->
2845

29-
### What should be covered while testing?
46+
<!-- Bug fix (non-breaking change which fixes an issue)
47+
<!---->
48+
49+
<!-- New feature (non-breaking change which adds functionality)
50+
<!---->
51+
52+
<!-- Breaking change (fix or feature that would cause existing functionality to change)
53+
<!---->
54+
55+
<!-- Test related change (New E2E test, test automation, etc.)
56+
<!---->
57+
58+
---
3059

31-
<!--- Describe what part of pacakge need to be tested and more important - how -->
60+
<!---
61+
Describe your changes in detail.
62+
Try to explain WHAT and WHY you change, fix or refactor.
63+
-->
64+
65+
### **Description**
66+
67+
---
68+
69+
<!--
70+
Please uncomment and fill in the following section
71+
to describe which part of the package needs to be tested
72+
and how it can be tested.
73+
-->
74+
<!--
75+
### What should be covered while testing?
76+
-->

0 commit comments

Comments
 (0)