-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from vxcontrol/issue-2-add-github-templates
[issue-2] add templates
- Loading branch information
Showing
4 changed files
with
212 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,64 @@ | ||
| name: "\U0001F41B Bug report" | ||
| description: "Report a bug with this project." | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| assignees: | ||
| - asdek | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! Please fill in as much of the template below as you can. | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the bug | ||
| description: Please write a clear and concise description of the bug, including what you expect to happen and what is currently happening. | ||
| placeholder: | | ||
| Feature '...' is not working properly. I expect '...' to happen, but '...' happens instead | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: Please write the steps needed to reproduce the bug. | ||
| placeholder: | | ||
| 1. Go to '...' | ||
| 2. Click on '...' | ||
| 3. Scroll down to '...' | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Screenshots, screen recording, code snippet | ||
| description: | | ||
| If possible, please upload a screenshot or screen recording which demonstrates the bug. You can use [LICEcap](https://www.cockos.com/licecap/) to create a GIF screen recording. | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| For small snippets paste it directly here, or you can use [GitHub Gist](https://gist.github.com) to share multiple code files. | ||
| Please ensure the shared code can be used by a developer to reproduce the issue—ideally it can be copied into a local development environment or executed in a browser console to help debug the issue | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Environment information | ||
| placeholder: | | ||
| - UI server version: <!-- [e.g. 3.2.0] --> | ||
| - Agent server version: <!-- [e.g. 3.2.0] --> | ||
| - Agent version: <!-- [e.g. 3.2.0] --> | ||
| - Module version: <!-- [e.g. 1.0.1] --> | ||
| - Link Module code: <!-- [link-to-zip-archive-with-helpful-code] --> | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: operating-systems | ||
| attributes: | ||
| label: Which agent binary used? | ||
| description: We have several different builds, choose which ones have the problem. | ||
| options: | ||
| - label: darwin-amd64 | ||
| - label: linux-386 | ||
| - label: linux-amd64 | ||
| - label: windows-386 | ||
| - label: windows-amd64 | ||
| validations: | ||
| 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,36 @@ | ||
| name: "\U0001F680 Enhancement" | ||
| description: "Suggest an idea for this project." | ||
| title: "[Enhancement]: " | ||
| labels: ["enhancement"] | ||
| assignees: | ||
| - asdek | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for suggesting an idea to make things better. Please fill in as much of the template below as you can. | ||
| - type: textarea | ||
| attributes: | ||
| label: Is your enhancement related to a problem? Please describe. | ||
| description: Please describe the problem you are trying to solve. | ||
| placeholder: | | ||
| I use this project as a `...` and I would like `...` so that `...describe benefit...`. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Designs | ||
| description: | | ||
| If applicable, add mockups/screenshots/etc. to help explain your idea. | ||
| Tip: You can attach images or videos by clicking this area to highlight it and then dragging files in. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe alternatives you've considered | ||
| description: | | ||
| Please describe alternative solutions or features you have considered. | ||
| placeholder: | | ||
| I have also considered `...describe alternative...`, however I feel that my solution described above is better because of `...reason...`. | ||
| validations: | ||
| required: false |
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,37 @@ | ||
| <!-- | ||
| Filling out this template is required. Any PR that does not include enough information to be reviewed may be closed at a maintainers' discretion. | ||
| --> | ||
|
|
||
| ### Description of the Change | ||
| <!-- | ||
| We must be able to understand the design of your change from this description. The maintainer reviewing this PR may not have worked with this code recently, so please provide as much detail as possible. | ||
| Where possible, please also include: | ||
| - verification steps to ensure your change has the desired effects and has not introduced any regressions | ||
| - any benefits that will be realized | ||
| - any alternative implementations or possible drawbacks that you considered | ||
| - screenshots or screencasts | ||
| --> | ||
|
|
||
| <!-- Enter any applicable Issue number(s) here that will be closed/resolved by this PR. --> | ||
| Closes # | ||
|
|
||
| ### How to test the Change | ||
| <!-- Please provide steps on how to test or validate that the change in this PR works as described. --> | ||
|
|
||
| ### Changelog Entry | ||
| <!-- | ||
| Please include a summary for this PR, noting whether this is something being Added / Changed / Deprecated / Removed / Fixed / or Security related. You can replace the sample entries after this comment block with the single changelog entry line for this PR. --> | ||
| > Added - New feature | ||
| > Changed - Existing functionality | ||
| > Deprecated - Soon-to-be removed feature | ||
| > Removed - Feature | ||
| > Fixed - Bug fix | ||
| > Security - Vulnerability | ||
| ### Checklist: | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you are unsure about any of these, please ask for clarification. We are here to help! --> | ||
| - [ ] I have updated the documentation accordingly. | ||
| - [ ] I have added tests to cover my change. | ||
| - [ ] All new and existing tests pass. |
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,75 @@ | ||
| # Saved Replies | ||
|
|
||
| In order to help reduce the time it takes to respond to open Issues and Pull Requests, we should leverage [GitHub’s Saved Replies](https://help.github.com/en/articles/about-saved-replies) to help when we are continually responding in the same manner. The following are various Saved Replies that the Soldr team should use to respond to Issues and Pull Requests to ensure our community responses are similar and to minimize the amount of time crafting the same response to different requests. | ||
|
|
||
| Since GitHub currently does not allow us to have a repository-wide or organization-wide list of [saved replies](https://help.github.com/articles/working-with-saved-replies/), these replies need to be maintained by individual team members. Since the replies can be modified in the future, all responses are versioned to simplify the process of keeping the replies up to date. | ||
|
|
||
| While these Saved Replies attempt to give you the ability to quickly reply to Issues and Pull Requests, they are not meant to be the _exact_ response you should use every time. Consider customizing them to fit the context of the Issue or Pull Request contribution you are replying to. You will be best served by welcoming the contributor to the project (if its their first issue/PR), thanking them for their contribution, giving them context to your response (especially if you're closing their issue/PR), and noting next steps (e.g., issue milestoned for a specific release, open to them submitting a PR to resolve an issue, sending a PR to someone else to review). | ||
|
|
||
| You can add these saved replies to [your personal GitHub account here](https://github.com/settings/replies). | ||
|
|
||
| _Sources: [1](https://github.com/angular/angular/blob/master/docs/SAVED_REPLIES.md), [2](https://github.com/angular/angular-cli/blob/master/.github/SAVED_REPLIES.md), [3](https://github.com/prometheus/docs/blob/master/snippets/saved_replies.md), & [4](https://gist.github.com/jywarren/c9a80e0e53f42208974683aa01c623c8)._ | ||
|
|
||
| ## Issue: already fixed (v1) | ||
| ``` | ||
| Thanks for filing this Issue! Fortunately it is now obsolete due to changes in a recent release. Please update to the most recent version to resolve the problem. | ||
| If you are still having problems after updating, then please provide additional details for us to try and replicate your issue. | ||
| ``` | ||
|
|
||
| ## Issue: don't understand (v1) | ||
| ``` | ||
| I'm sorry but I don't understand the problem you are reporting. Would you please rephrase your issue so I can attempt to better understand it? | ||
| ``` | ||
|
|
||
| ## Issue: can't reproduce (v1) | ||
| ``` | ||
| Thanks for filing this Issue! Unfortunately I cannot reproduce the problem following the instructions you provided. We require that reported issues have reproduction steps that highlights the problem. | ||
| If the problem still exists for you, then please include any additional information on how to reproduce it. | ||
| ``` | ||
|
|
||
| ## Issue: behaving as expected (v1) | ||
| ``` | ||
| It appears this behaves as expected. If you still feel there is an issue, please provide further details on your problem. | ||
| ``` | ||
|
|
||
| ## Issue: template missing (v1) | ||
| ``` | ||
| Thanks for filing this Issue! Please note that we have Issue templates for [bug](https://github.com/vxcontrol/soldr/blob/master/.github/ISSUE_TEMPLATE/1-bug-report.md), [enhancement](https://github.com/vxcontrol/soldr/blob/master/.github/ISSUE_TEMPLATE/2-enhancement.md). I would appreciate it if you could edit your Issue and add in the missing details. | ||
| ``` | ||
|
|
||
| ## Issue: PR please? (v1) | ||
| ``` | ||
| I would love your help on this Issue, would be happy to review a PR for it, and will attempt to provide any assistance you might need. | ||
| ``` | ||
|
|
||
| ## Issue or PR: duplicate (v1) | ||
| ``` | ||
| Thanks for filing this (issue, PR). However this is a duplicate of an existing (issue, PR) #NUMBER, so I'm closing this but if you think this was in error then don't hesitate to comment. Otherwise please subscribe to #NUMBER for future updates. | ||
| ``` | ||
|
|
||
| ## Issue or PR: close as inactive (v1) | ||
| ``` | ||
| I'm closing this issue due to inactivity, but please let me know if you're still having problems so I can try to help... thanks! | ||
| ``` | ||
|
|
||
| ## Issue or PR: send for help! (v1) | ||
| ``` | ||
| Thanks for filing this! Unfortunately I’m uncertain on how to proceed here, so I’m pinging (@maintainer, @10up/open-source-practice) for their input. | ||
| ``` | ||
|
|
||
| ## PR: merging and more (v1) | ||
| ``` | ||
| This looks perfect, so I'll merge it. If you are looking for another challenge, then please take a look at our `help-wanted` list: https://github.com/vxcontrol/soldr/labels/help-wanted. Thanks! | ||
| ``` | ||
|
|
||
| ## PR: template missing (v1) | ||
| ``` | ||
| Thanks for filing this PR! Please note that we have a [PR template](https://github.com/vxcontrol/soldr/blob/master/.github/PULL_REQUEST_TEMPLATE.md) that is required. I would appreciate it if you could edit your PR and add in the missing details. | ||
| ``` | ||
|
|
||
| ## PR: missing related Issue (v1) | ||
| ``` | ||
| Thanks for filing this PR! Please note that we require an Issue for each PR so that approach and other details can be discussed in the Issue while code review can happen in the PR. I would appreciate it if you could [open an Issue](https://github.com/vxcontrol/soldr/issues/new/choose) and link it to this PR for further discussion. | ||
| ``` |