generated from oracle/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 3
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 #40 from oracle/er_39_github_templates
dx(GitHub-templates): add GitHub templates for PRs, ERs and Bug Reports, resolves #39
- Loading branch information
Showing
4 changed files
with
189 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,95 @@ | ||
name: Bug Report | ||
description: File a bug report for issues. | ||
title: "[Bug] <title>" | ||
labels: ["bug"] | ||
projects: ["oracle/16"] | ||
assignees: | ||
- mig8447 | ||
- dbtools-antcampo | ||
- LeonSilva15 | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: "## If you plan to send a PR, please add your username to the assignees list." | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: repro | ||
attributes: | ||
label: Reproduction steps | ||
description: "How do you trigger this bug? Please walk us through it step by step." | ||
value: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
... | ||
render: bash | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expect | ||
attributes: | ||
label: Expected Behavior | ||
description: A clear and concise description of what is the expected behavior. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: ss | ||
attributes: | ||
label: Screenshots | ||
description: | | ||
If applicable, add screenshots to help explain your problem. | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: env | ||
attributes: | ||
label: Environment | ||
description: | | ||
examples: | ||
- **Device**: iPhone6, Desktop | ||
- **OS (with version)**: iOS, iOS8.1 | ||
- **Browser**: Chrome, Safari, Stock Browser | ||
- **Version**: 7.6.3 | ||
- **Shell**: bash, zsh | ||
value: | | ||
- Device: | ||
- OS (with version): | ||
- Browser: | ||
- Version: | ||
- Shell: | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: shell | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: extra | ||
attributes: | ||
label: Anything else? | ||
description: Links? References? Anything that will give us more context about the issue you are encountering! | ||
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,15 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: README | ||
url: https://github.com/oracle/create-database-app/blob/main/README.md | ||
about: Basic documentation of the project. | ||
- name: Contributing Guidelines | ||
url: https://github.com/oracle/create-database-app/blob/main/CONTRIBUTING.md | ||
about: How to contribute to the project. | ||
issue_template: | ||
- name: Bug Report | ||
description: Use this template to report any issue. | ||
template: bug_report.yml | ||
- name: Enhancement Request | ||
description: Use this template to suggest a new enhancement/feature for this project. | ||
template: enhancement_request.yml |
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,52 @@ | ||
name: Enhancement Request | ||
description: Suggest an idea for this project | ||
title: "[Enhancement] <title>" | ||
labels: ["enhancement", "documentation"] | ||
projects: ["oracle/16"] | ||
assignees: | ||
- mig8447 | ||
- dbtools-antcampo | ||
- LeonSilva15 | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Thank you for contributing to our project! | ||
If you plan to send a PR, please add your username to the assignees list. | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: Is your enhancement/feature request related to a problem? | ||
description: If applicable, please provide a clear and concise description of what the problem is. | ||
placeholder: Ex. I'm always frustrated when [...] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the expected behavior | ||
description: A clear and concise description of what you want to happen. | ||
placeholder: Ex. I would like to [...] | ||
value: "We need this!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or enhancements you've considered. | ||
placeholder: Ex. Maybe you could remove [...] or add [...] | ||
value: "Every idea has its own potential" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: extra | ||
attributes: | ||
label: Additional context? | ||
description: | | ||
Links? References? Anything that will give us about the enhancement request here. | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
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,27 @@ | ||
# [PR] <title> | ||
|
||
## Description | ||
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. List any dependencies that are required for this change. | ||
|
||
Fixes # (issue number) | ||
|
||
## Type of change | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
## How Has This Been Tested? | ||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration | ||
|
||
- [ ] Test A | ||
- [ ] Test B | ||
|
||
## Checklist: | ||
- [ ] 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/errors | ||
- [ ] 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 |