-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* First drafts for two issue templates to be proposed. Curious to see how they render. * Fixed up the formatting a little on the bug report introduction * Added to the contributing guidelines to be in line with the templates a little more fluidly.
- Loading branch information
1 parent
3a2e8e6
commit 9612af4
Showing
3 changed files
with
144 additions
and
6 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,78 @@ | ||
| name: "\U0001F41E Bug report" | ||
| description: File a bug report | ||
| title: "[Bug]: " | ||
| labels: ["bug: pending review"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! 🧬 | ||
| We are looking forward to collaborating and resolving the issue. | ||
| By following these instructions, fill every question, and do every step we will be best equiped to work towards a solution. 🙏 | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: First Check | ||
| description: Please confirm and check all the following options. | ||
| options: | ||
| - label: I added a very descriptive title to this issue. | ||
| required: true | ||
| - label: Check that there isn't [already an issue](https://github.com/uab-cgds-worthey/rosalution/issues/) that reports the same bug to avoid creating a duplicate. | ||
| required: true | ||
| - label: Follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) | ||
| required: true | ||
| - label: Read the [Contributing Guidelines](../../CONTRIBUTING.md). | ||
| required: true | ||
| - 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: I am doing ... What I expect is ... What actually happening is ... | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: browsers | ||
| attributes: | ||
| label: What browsers are you seeing the problem on if accessed via the browser? | ||
| multiple: true | ||
| options: | ||
| - Firefox | ||
| - Chrome | ||
| - Not in browser | ||
| - type: input | ||
| id: browsers-version | ||
| attributes: | ||
| label: Version | ||
| description: What version of the browser(s) or cURL are you running? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction-steps | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: | | ||
| Please provide any reproduction steps that may need to be described. | ||
| If reproduced from a local deployment, confirm your [local environment was setup successfuly](../../README.md#getting-started). | ||
| placeholder: | | ||
| * (optional) If from local development version: Verified environment setup environment with `.setup.sh` and sourced shell, then `docker-compose up` | ||
| * Open the browser and call the endpoint `/`. | ||
| * It renders an empty rosalution dashboard. | ||
| * But I expected it to route me to the login page. | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: Please copy and paste any relevant log output. Either browser console logs or cURL http request logs. This will be automatically formatted into code, so no need for backticks. | ||
| render: shell | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| 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,55 @@ | ||
| name: "\U0001F9EC New feature proposal" | ||
| description: Propose a new feature to be added | ||
| labels: ["enhancement: pending review"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for your interest in the project and taking the time to fill out this feature proposal! 🙏 | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: First Check | ||
| description: Please confirm and check all the following options. | ||
| options: | ||
| - label: I added a very descriptive title to this issue. | ||
| required: true | ||
| - label: Check that there isn't [already an proposed enhancement](https://github.com/uab-cgds-worthey/rosalution/issues/) that accomplishes the same thing. | ||
| required: true | ||
| - label: Follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) | ||
| required: true | ||
| - label: Read the [Contributing Guidelines](../../CONTRIBUTING.md). | ||
| required: true | ||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: Description | ||
| description: "Clear and concise description of the problem. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this issue, tell us in the description. Thanks!" | ||
| placeholder: As a [] type of user for Rosalution I want [goal / wish] so that [benefit]. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: suggested-solution | ||
| attributes: | ||
| label: Suggested solution | ||
| description: "In section [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: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this feature proposal, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| 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