Skip to content

Commit c0e61cc

Browse files
authored
Merge pull request #1735 from module-federation/workflow/add-pull-request-template
workflow: add pull_request_template and issue_template
2 parents cfd05a5 + dafb6d0 commit c0e61cc

File tree

5 files changed

+136
-0
lines changed

5 files changed

+136
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: "\U0001F41E Bug report"
2+
description: Report an issue with Module federation
3+
labels: [pending triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
14+
placeholder: Bug description
15+
validations:
16+
required: true
17+
- type: input
18+
id: reproduction
19+
attributes:
20+
label: Reproduction
21+
description: Please provide a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
22+
placeholder: Reproduction
23+
validations:
24+
required: true
25+
- type: dropdown
26+
id: package-manager
27+
attributes:
28+
label: Used Package Manager
29+
description: Select the used package manager
30+
options:
31+
- npm
32+
- yarn
33+
- pnpm
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: system-info
38+
attributes:
39+
label: System Info
40+
description: Output of `npx envinfo --system --binaries --browsers` (Does not support monorepo, you need to enter the main application package.json location)
41+
render: shell
42+
placeholder: System, Binaries, Browsers
43+
validations:
44+
required: true
45+
- type: checkboxes
46+
id: checkboxes
47+
attributes:
48+
label: Validations
49+
description: Before submitting the issue, please make sure you do the following
50+
options:
51+
- label: Read the [docs](https://github.com/module-federation/universe).
52+
required: true
53+
- label: Read the [common issues list](https://github.com/module-federation/universe/issues).
54+
required: true
55+
- label: Check that there isn't [already an issue](https://github.com/module-federation/universe/issues) that reports the same bug to avoid creating a duplicate.
56+
required: true
57+
- label: Make sure this is a Module federation issue and not a framework-specific issue.
58+
required: true
59+
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
60+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions & Discussions
4+
url: https://github.com/module-federation/universe/discussions
5+
about: Use GitHub discussions for message-board style questions and discussions.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "\U0001F680 New feature proposal"
2+
description: Propose a new feature to be added to Module federation
3+
labels: ['enhancement: pending triage']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for your interest in the project and taking the time to fill out this feature report!
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: Clear and concise description of the problem
13+
description: 'As a developer using Module federation I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: suggested-solution
18+
attributes:
19+
label: Suggested solution
20+
description: 'In module [xy] we could provide following implementation...'
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternative
25+
attributes:
26+
label: Alternative
27+
description: Clear and concise description of any alternative solutions or features you've considered.
28+
- type: textarea
29+
id: additional-context
30+
attributes:
31+
label: Additional context
32+
description: Any other context or screenshots about the feature request here.
33+
- type: checkboxes
34+
id: checkboxes
35+
attributes:
36+
label: Validations
37+
description: Before submitting the issue, please make sure you do the following
38+
options:
39+
- label: Read the [Contributing Guidelines](https://github.com/module-federation/universe/blob/canary/CONTRIBUTING.md).
40+
required: true
41+
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
42+
required: true

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Description
2+
3+
<!--- Provide a general summary of your changes in the Title above -->
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
8+
<!--- This project only accepts pull requests related to open issues -->
9+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
10+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
11+
<!--- Please link to the issue here: -->
12+
13+
14+
## Types of changes
15+
16+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
17+
18+
- [ ] Docs change / refactoring / dependency upgrade
19+
- [ ] Bug fix (non-breaking change which fixes an issue)
20+
- [ ] New feature (non-breaking change which adds functionality)
21+
22+
## Checklist
23+
24+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
25+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
26+
27+
- [ ] I have added tests to cover my changes.
28+
- [ ] All new and existing tests passed.
29+
- [ ] I have updated the documentation.

.husky/commit-msg

100644100755
File mode changed.

0 commit comments

Comments
 (0)