-
-
Notifications
You must be signed in to change notification settings - Fork 281
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add pull_request_template and issue template
- Loading branch information
zhouxiao.shaw
committed
Dec 7, 2023
1 parent
cfd05a5
commit f903b91
Showing
4 changed files
with
136 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: "\U0001F41E Bug report" | ||
description: Report an issue with Module federation | ||
labels: [pending triage] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Describe the bug | ||
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! | ||
placeholder: Bug description | ||
validations: | ||
required: true | ||
- type: input | ||
id: reproduction | ||
attributes: | ||
label: Reproduction | ||
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. | ||
placeholder: Reproduction | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: package-manager | ||
attributes: | ||
label: Used Package Manager | ||
description: Select the used package manager | ||
options: | ||
- npm | ||
- yarn | ||
- pnpm | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: system-info | ||
attributes: | ||
label: System Info | ||
description: Output of `npx envinfo --system --binaries --browsers` (Does not support monorepo, you need to enter the main application package.json location) | ||
render: shell | ||
placeholder: System, Binaries, Browsers | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Read the [docs](https://github.com/module-federation/universe). | ||
required: true | ||
- label: Read the [common issues list](https://github.com/module-federation/universe/issues). | ||
required: true | ||
- 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. | ||
required: true | ||
- label: Make sure this is a Module federation issue and not a framework-specific issue. | ||
required: true | ||
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Questions & Discussions | ||
url: https://github.com/module-federation/universe/discussions | ||
about: Use GitHub discussions for message-board style questions and discussions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: "\U0001F680 New feature proposal" | ||
description: Propose a new feature to be added to Module federation | ||
labels: ["enhancement: pending triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Clear and concise description of the problem | ||
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!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: suggested-solution | ||
attributes: | ||
label: Suggested solution | ||
description: "In module [xy] we could provide following implementation..." | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: alternative | ||
attributes: | ||
label: Alternative | ||
description: Clear and concise description of any alternative solutions or features you've considered. | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Any other context or screenshots about the feature request here. | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Read the [Contributing Guidelines](https://github.com/module-federation/universe/blob/canary/CONTRIBUTING.md). | ||
required: true | ||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
## Description | ||
|
||
<!--- Provide a general summary of your changes in the Title above --> | ||
<!--- Describe your changes in detail --> | ||
|
||
## Related Issue | ||
|
||
<!--- This project only accepts pull requests related to open issues --> | ||
<!--- If suggesting a new feature or change, please discuss it in an issue first --> | ||
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> | ||
<!--- Please link to the issue here: --> | ||
|
||
|
||
## Types of changes | ||
|
||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
|
||
- [ ] Docs change / refactoring / dependency upgrade | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
|
||
## Checklist | ||
|
||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
|
||
- [ ] I have added tests to cover my changes. | ||
- [ ] All new and existing tests passed. | ||
- [ ] I have updated the documentation. |