chore: update issue and PR templates (#3113)

* chore: update issue templates

* add template to PRs

* update for pr titles

* update

* update

* update description
This commit is contained in:
Alireza 2023-01-11 16:53:35 -05:00 committed by GitHub
parent 5d9e4c9b02
commit cb9aa6a765
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 119 additions and 32 deletions

View File

@ -2,23 +2,21 @@
name: "\U0001F41B Bug report" name: "\U0001F41B Bug report"
about: Create a report to help us improve about: Create a report to help us improve
title: '' title: ''
labels: 'Community: Report :bug:, Awaiting Reproduction, Triage :white_flag:' labels: 'Community: Report :bug:, Awaiting Reproduction'
assignees: '' assignees: ''
--- ---
> **Before Creating an issue** <!-- ⚠️⚠️ Do Not Delete This! bug_report_template ⚠️⚠️ -->
> <!-- Please read our Rules of Conduct: https://github.com/OHIF/Viewers/blob/master/CODE_OF_CONDUCT.md -->
> - Are you running the latest version? <!-- 🕮 Read our guide about our process: https://v3-docs.ohif.org/development/our-process -->
> - Are you reporting to the correct repository? <!-- 🔎 Search existing issues to avoid creating duplicates. -->
> - Did you search existing issues? <!-- 🧪 Test using the latest version -->
## Bug Report
### Describe the Bug ### Describe the Bug
_A clear and concise description of what the bug is._ _A clear and concise description of what the bug is._
### What steps can we follow to reproduce the bug? ### Steps to Reproduce:
1. First step 1. First step
2. Second step 2. Second step
@ -28,6 +26,15 @@ _A clear and concise description of what the bug is._
Please use code blocks to show formatted errors or code snippets Please use code blocks to show formatted errors or code snippets
``` ```
### The current behavior
_A clear and concise description of what happens instead of the expected
behavior._
### The expected behavior
_A clear and concise description of what you expected to happen._
> :warning: Reports we cannot reproduce are at risk of being marked stale and > :warning: Reports we cannot reproduce are at risk of being marked stale and
> closed. The more information you can provide, the more likely we are to look > closed. The more information you can provide, the more likely we are to look
> into and address your issue. > into and address your issue.

View File

@ -2,19 +2,28 @@
name: "\U0001F680 Feature request" name: "\U0001F680 Feature request"
about: Suggest an idea for this project about: Suggest an idea for this project
title: '' title: ''
labels: 'Community: Request :hand:, Triage :white_flag:' labels: 'Community: Request :hand:'
assignees: '' assignees: ''
--- ---
> :hand: Many people requests features. Tell us why yours is important to the <!-- ⚠️⚠️ Do Not Delete This! feature_request_template ⚠️⚠️ -->
<!-- Please read our Rules of Conduct: https://github.com/OHIF/Viewers/blob/master/CODE_OF_CONDUCT.md -->
<!-- :hand: Many people requests features. Tell us why yours is important to the
> community. How does it add value? Why _this feature_? > community. How does it add value? Why _this feature_?
> >
> Is your request very specific to your needs? Consider > Is your request very specific to your needs? Consider
> [contributing it](https://docs.ohif.org/contributing.html) yourself! Or reach > [contributing it](https://v3-docs.ohif.org/development/contributing) yourself!
> out to a community member that offers > Or reach out to a community member that offers
> [consulting services](https://docs.ohif.org/help.html#paid--commercial). > [consulting services](https://docs.ohif.org/help.html#paid--commercial).
-->
## Request ### Request
<!--
Please include as much detail as possible including possibly mock up screen shots, workflow or logic flow diagrams etc.
Discuss if and how the requested feature interacts with existing features
-->
**What feature or change would you like to see made?** **What feature or change would you like to see made?**

View File

@ -1,15 +1,92 @@
### PR Checklist <!-- Do Not Delete This! pr_template -->
<!-- Please read our Rules of Conduct: https://github.com/OHIF/Viewers/blob/master/CODE_OF_CONDUCT.md -->
- [ ] Brief description of changes <!-- 🕮 Read our guide about our Contributing Guide here https://v3-docs.ohif.org/development/contributing -->
- [ ] Links to any relevant issues <!-- :hand: Thank you for starting this amazing contribution! -->
- [ ] Required status checks are passing
- [ ] User cases if changes impact the user's experience
- [ ] `@mention` a maintainer to request a review
<!-- <!--
Links ⚠️⚠️ Please make sure the checklist section below is complete before submitting your PR.
To complete the checklist, add an 'x' to each item: [] -> [x]
(PRs that do not have all the checkboxes marked will not be approved)
--> -->
### Context
<!--
Provide a clear explanation of the reasoning behind this change, such as:
- A link to the issue being addressed, using the format "Fixes #ISSUE_NUMBER"
- An image showing the issue or problem being addressed (if not already in the issue)
- Error logs or callStacks to help with the understanding of the problem (if not already in the issue)
-->
### Changes & Results
<!--
List all the changes that have been done, such as:
- Add new components
- Remove old components
- Update dependencies
What are the effects of this change?
- Before vs After
- Screenshots / GIFs / Videos
-->
### Testing
<!--
Describe how we can test your changes.
- open a URL
- visit a page
- click on a button
- etc.
-->
### Checklist
#### PR
<!--
https://semantic-release.gitbook.io/semantic-release/#how-does-it-work
Examples:
Please note the letter casing in the provided examples (upper or lower).
- feat(MeasurementService): add ...
- fix(Toolbar): fix ...
- docs(Readme): update ...
- style(Whitespace): fix ...
- refactor(ExtensionManager): ...
- test(HangingProtocol): Add test ...
- chore(git): update ...
- perf(VolumeLoader): ...
You don't need to have each commit within the Pull Request follow the rule,
but the PR title must comply with it, as it will be used as the commit message
after the commits are squashed.
-->
- [] My Pull Request title is descriptive, accurate and follows the
semantic-release format and guidelines.
#### Code
- [] My code has been well-documented (function documentation, inline comments,
etc.)
#### Public Documentation Updates
<!-- https://v3-docs.ohif.org/ -->
- [] The documentation page has been updated as necessary for any public API
additions or removals.
#### Tested Environment
- [] "OS: <!--[e.g. Windows 10, macOS 10.15.4]"-->
- [] "Node version: <!--[e.g. 16.14.0]"-->
- [] "Browser:
<!--[e.g. Chrome 83.0.4103.116, Firefox 77.0.1, Safari 13.1.1]"-->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
[blog]: https://circleci.com/blog/triggering-trusted-ci-jobs-on-untrusted-forks/ [blog]: https://circleci.com/blog/triggering-trusted-ci-jobs-on-untrusted-forks/
[script]: https://github.com/jklukas/git-push-fork-to-upstream-branch [script]: https://github.com/jklukas/git-push-fork-to-upstream-branch

12
.github/stale.yml vendored
View File

@ -4,23 +4,17 @@
# Number of days of inactivity before an issue becomes stale # Number of days of inactivity before an issue becomes stale
daysUntilStale: 180 daysUntilStale: 180
# Number of days of inactivity before a stale issue is closed # Number of days of inactivity before a stale issue is closed
daysUntilClose: 9000 daysUntilClose: 60
# Issues with these labels will never be considered stale # Issues with these labels will never be considered stale
exemptLabels: exemptLabels:
- 'Story :raised_hands:'
- 'Bug: Verified :bug:' - 'Bug: Verified :bug:'
- 'Task: CI/Tooling :robot:'
- 'Task: Docs 📖'
- 'Task: Docs :book:'
- 'Task: Refactor :hammer_and_wrench:'
- 'Task: Tests :microscope:'
- 'PR: Awaiting Review 👀' - 'PR: Awaiting Review 👀'
- 'Triage :white_flag:'
- 'Extension: Discussion'
- 'Announcement 🎉' - 'Announcement 🎉'
- 'IDC:priority' - 'IDC:priority'
- 'IDC:candidate' - 'IDC:candidate'
- 'IDC:collaboration' - 'IDC:collaboration'
- 'Community: Request :hand:'
- 'Community: Report :bug:'
# Label to use when marking an issue as stale # Label to use when marking an issue as stale
staleLabel: 'Stale :baguette_bread:' staleLabel: 'Stale :baguette_bread:'
# Comment to post when marking an issue as stale. Set to `false` to disable # Comment to post when marking an issue as stale. Set to `false` to disable