-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add contributing how to and bug/feature req
- Loading branch information
Showing
4 changed files
with
265 additions
and
7 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,111 @@ | ||
| name: "\U0001F41B Bug Report" | ||
| description: "If something isn't working as expected \U0001F914" | ||
| labels: ["needs triage"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## :warning: We use GitHub Issues to track bug reports and feature requests | ||
| If you are not sure that your issue is a bug, you could: | ||
|
|
||
| - use our [Discord community](https://discord.gg/A877Mc3V) | ||
| - use [StackOverflow using the tag `expressots`](https://stackoverflow.com/questions/tagged/expressots) | ||
|
|
||
| **NOTE:** You don't need to answer questions that you know that aren't relevant. | ||
|
|
||
| --- | ||
| - type: markdown | ||
| attributes: | ||
| value: Thanks for taking the time to complete this bug report! | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Guidelines | ||
| description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/expressots/expresso-site-doc/blob/main/CONTRIBUTING.md). | ||
| options: | ||
| - label: I agree to follow this project's Contributing Guidelines. | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| attributes: | ||
| label: "Is there an existing issue for this?" | ||
| description: "Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered" | ||
| options: | ||
| - label: "I have searched the existing issues" | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: existing-issues | ||
| attributes: | ||
| label: Existing Issues | ||
| description: Are there any similar existing issues? | ||
| placeholder: "#42" | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "Current behavior" | ||
| description: "How the issue manifests?" | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: "Steps to reproduce" | ||
| description: | | ||
| How the issue manifests? | ||
| You could leave this blank if you can't reproduce it, but please provide as much information as possible | ||
| placeholder: | | ||
| 1. `npm ci` | ||
| 2. `npm start:dev` | ||
| 3. See error... | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "Expected behavior" | ||
| description: "A clear and concise description of what you expected to happened (or code)" | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| - type: input | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "Package version" | ||
| description: | | ||
| Which version of `@expressots/core` are you using? | ||
| **Tip**: Make sure that all of yours `@expressots/*` dependencies are in sync! | ||
| placeholder: "1.2.0" | ||
|
|
||
| - type: input | ||
| attributes: | ||
| label: "Node.js version" | ||
| description: "Which version of Node.js are you using?" | ||
| placeholder: "18.0.10" | ||
|
|
||
| - type: checkboxes | ||
| attributes: | ||
| label: "In which operating systems have you tested?" | ||
| options: | ||
| - label: macOS | ||
| - label: Windows | ||
| - label: Linux | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| - type: textarea | ||
| attributes: | ||
| label: "Other" | ||
| description: | | ||
| Anything else relevant? eg: Logs, OS version, IDE, package manager, etc. | ||
| **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in |
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,73 @@ | ||
| name: "\U0001F680 Community Ideas" | ||
| description: "I have an idea or proposal \U0001F4A1!" | ||
| labels: ["needs triage"] | ||
| assignees: | ||
| - "rsaz" | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## :heart: We would love to hear your ideas and proposals | ||
| Suggest an idea for a specific feature, product, process, anything you wish to propose to the community for comment and discussion. | ||
|
|
||
| **NOTE:** If your idea is approved after discussion, you will be asked to create a new issue with the appropriate template. | ||
|
|
||
| --- | ||
|
|
||
| - type: checkboxes | ||
| attributes: | ||
| label: "Is there an existing proposal similar to this?" | ||
| description: "Please make sure that your idea is not already proposed otherwise you will be asked to comment on the existing proposal" | ||
| options: | ||
| - label: "I have searched the existing proposals" | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "What are you proposing?" | ||
| description: "In a few sentences, describe your idea or proposal" | ||
| placeholder: | | ||
| My idea is ... | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "Is there any specific group of users that will benefit from this?" | ||
| description: "Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, Twitter, Etc" | ||
| placeholder: | | ||
| I have seen ... | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "What problems are you trying to solve?" | ||
| description: "Describe the problems that this idea or proposal will solve" | ||
| placeholder: | | ||
| I am trying to solve ... | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "Do you have any references or examples that can illustrate your idea?" | ||
| description: "If you have any references or examples that can illustrate your idea, who is using it, and how it is being used, please share them here" | ||
| placeholder: | | ||
| I have seen ... | ||
| - type: dropdown | ||
| id: idea-type | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: "What type of idea is this?" | ||
| description: "Select the type of idea that this is" | ||
| multiple: false | ||
| options: | ||
| - "Innovation: No similar idea exists" | ||
| - "Improvement of existing idea: Similar idea exists but this is an improvement" | ||
| - "Copy of existing idea: Similar idea exists and this is a copy" |
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 @@ | ||
| # Pull Request Guidelines | ||
|
|
||
| Our guidelines for submitting a pull request. | ||
|
|
||
| ## Before submitting a Pull Request, please make sure you have verified the following: | ||
|
|
||
| - [ ] My code follows the style guidelines of this project | ||
| - [ ] I have performed a self-review of my own code | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] New and existing unit tests pass locally with my changes | ||
| - [ ] Any dependent changes have been merged and published in downstream modules | ||
|
|
||
| ## PR Type | ||
|
|
||
| What kind of change does this PR introduce? | ||
|
|
||
| <!-- Please check the one that applies to this PR using "x". --> | ||
| - [ ] Documentation fix | ||
| - [ ] Documentation update | ||
| - [ ] New Feature | ||
| - [ ] Translation:: New language | ||
| - [ ] Bugfix | ||
| - [ ] Code style update (formatting, local variables) | ||
| - [ ] Refactoring (no functional changes, no api changes) | ||
| - [ ] Build related changes | ||
| - [ ] CI related changes | ||
| - [ ] Other... Please describe: | ||
|
|
||
| ## What is the current behavior? | ||
|
|
||
| Please describe the current behavior that you are modifying, or link to a relevant issue. | ||
| Issue Number: N/A | ||
|
|
||
| -> Response: | ||
|
|
||
| ## What is the new behavior? | ||
|
|
||
| Describe the new behavior or link to a relevant issue. | ||
|
|
||
| -> Response: | ||
|
|
||
| ## Does this PR introduce a breaking change? | ||
|
|
||
| - [ ] Yes | ||
| - [ ] No | ||
|
|
||
| If this PR contains a breaking change, please describe the impact and migration path for existing applications below. | ||
|
|
||
| -> Response: | ||
|
|
||
| ## Other information | ||
|
|
||
| Any other information that is important to this PR. | ||
|
|
||
| - [ ] N/A | ||
|
|
||
| -> Response: |
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