From d79759b32cb61764b4ce09295382d3a2aee20ae6 Mon Sep 17 00:00:00 2001 From: Alireza Date: Wed, 11 Jan 2023 15:14:59 -0500 Subject: [PATCH 1/6] chore: update issue templates --- .github/ISSUE_TEMPLATE/---bug-report.md | 11 ++++++++++- .github/ISSUE_TEMPLATE/---feature-request.md | 6 +++--- .github/stale.yml | 12 +++--------- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index 8c4cab1fb00..c77f03e68db 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -2,7 +2,7 @@ name: "\U0001F41B Bug report" about: Create a report to help us improve title: '' -labels: 'Community: Report :bug:, Awaiting Reproduction, Triage :white_flag:' +labels: 'Community: Report :bug:, Awaiting Reproduction' assignees: '' --- @@ -28,6 +28,15 @@ _A clear and concise description of what the bug is._ 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 > closed. The more information you can provide, the more likely we are to look > into and address your issue. diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md index d0cabe09f63..322e68c7507 100644 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ b/.github/ISSUE_TEMPLATE/---feature-request.md @@ -2,7 +2,7 @@ name: "\U0001F680 Feature request" about: Suggest an idea for this project title: '' -labels: 'Community: Request :hand:, Triage :white_flag:' +labels: 'Community: Request :hand:' assignees: '' --- @@ -10,8 +10,8 @@ assignees: '' > community. How does it add value? Why _this feature_? > > Is your request very specific to your needs? Consider -> [contributing it](https://docs.ohif.org/contributing.html) yourself! Or reach -> out to a community member that offers +> [contributing it](https://v3-docs.ohif.org/development/contributing) yourself! +> Or reach out to a community member that offers > [consulting services](https://docs.ohif.org/help.html#paid--commercial). ## Request diff --git a/.github/stale.yml b/.github/stale.yml index 0d11ecb9117..4d6cdd4e356 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -4,23 +4,17 @@ # Number of days of inactivity before an issue becomes stale daysUntilStale: 180 # Number of days of inactivity before a stale issue is closed -daysUntilClose: 9000 +daysUntilClose: 60 # Issues with these labels will never be considered stale exemptLabels: - - 'Story :raised_hands:' - 'Bug: Verified :bug:' - - 'Task: CI/Tooling :robot:' - - 'Task: Docs 📖' - - 'Task: Docs :book:' - - 'Task: Refactor :hammer_and_wrench:' - - 'Task: Tests :microscope:' - 'PR: Awaiting Review 👀' - - 'Triage :white_flag:' - - 'Extension: Discussion' - 'Announcement 🎉' - 'IDC:priority' - 'IDC:candidate' - 'IDC:collaboration' + - 'Community: Request :hand:' + - 'Community: Report :bug:' # Label to use when marking an issue as stale staleLabel: 'Stale :baguette_bread:' # Comment to post when marking an issue as stale. Set to `false` to disable From 45643edf06b30049a9bd89d1b776fac671328040 Mon Sep 17 00:00:00 2001 From: Alireza Date: Wed, 11 Jan 2023 15:51:55 -0500 Subject: [PATCH 2/6] add template to PRs --- .github/ISSUE_TEMPLATE/---bug-report.md | 14 ++--- .github/ISSUE_TEMPLATE/---feature-request.md | 8 ++- .github/pull_request_template.md | 61 +++++++++++++++++--- 3 files changed, 65 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index c77f03e68db..8d4faac76e4 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -6,19 +6,17 @@ labels: 'Community: Report :bug:, Awaiting Reproduction' assignees: '' --- -> **Before Creating an issue** -> -> - Are you running the latest version? -> - Are you reporting to the correct repository? -> - Did you search existing issues? - -## Bug Report + + + + + ### Describe the Bug _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 2. Second step diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md index 322e68c7507..c3360242ae2 100644 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ b/.github/ISSUE_TEMPLATE/---feature-request.md @@ -6,15 +6,19 @@ labels: 'Community: Request :hand:' assignees: '' --- -> :hand: Many people requests features. Tell us why yours is important to the + + + + -## Request +### Request **What feature or change would you like to see made?** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4a5623153a3..84da4df12c3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,14 +1,59 @@ -### PR Checklist + + + + -- [ ] Brief description of changes -- [ ] Links to any relevant issues -- [ ] Required status checks are passing -- [ ] User cases if changes impact the user's experience -- [ ] `@mention` a maintainer to request a review +### 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 +- Error logs or callStacks to help with the understanding of the problem +--> + +### Changes & Results + + + +### Testing + + + +### Checklist + +#### Code + +- [] The code has been well-documented to help with understanding and + maintenance. + +#### Public Documentation Updates + + + +- [] 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: [e.g. 16.14.0]" +- [] "Browser: [e.g. Chrome 83.0.4103.116, Firefox 77.0.1, Safari 13.1.1]" [blog]: https://circleci.com/blog/triggering-trusted-ci-jobs-on-untrusted-forks/ From aad28b6e2a8e15f0eddb17ab6e98b178277dad2f Mon Sep 17 00:00:00 2001 From: Alireza Date: Wed, 11 Jan 2023 16:08:20 -0500 Subject: [PATCH 3/6] update for pr titles --- .github/pull_request_template.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 84da4df12c3..a512108229e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,6 +2,8 @@ + ### Context @@ -37,10 +39,31 @@ Describe how we can test your changes. ### Checklist +#### PR + + + +- [] My Pull Request title above is meaningful and follows semantic-release + format and guidelines. + #### Code -- [] The code has been well-documented to help with understanding and - maintenance. +- [] My code has been well-documented (function documentation, inline comments, + etc.) #### Public Documentation Updates From 2790219642d31d9ac91a161d5a81afdaebfd8380 Mon Sep 17 00:00:00 2001 From: Alireza Date: Wed, 11 Jan 2023 16:10:34 -0500 Subject: [PATCH 4/6] update --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a512108229e..422102aba73 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -57,8 +57,8 @@ Examples: ⚠️⚠️ Please note the letter casing in the provided examples (upper or lower). ⚠️⚠️ --> -- [] My Pull Request title above is meaningful and follows semantic-release - format and guidelines. +- [] My Pull Request title is accurate and follows the semantic-release format + and guidelines. #### Code From cd7e98acd9cece8aca4833d3a42feed1370c6d20 Mon Sep 17 00:00:00 2001 From: Alireza Date: Wed, 11 Jan 2023 16:25:53 -0500 Subject: [PATCH 5/6] update --- .github/pull_request_template.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 422102aba73..33f5d36d89e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,13 @@ - + - + + ### Context @@ -45,6 +49,8 @@ Describe how we can test your changes. 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 ... @@ -54,11 +60,13 @@ Examples: - chore(git): update ... - perf(VolumeLoader): ... -⚠️⚠️ Please note the letter casing in the provided examples (upper or lower). ⚠️⚠️ +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 accurate and follows the semantic-release format - and guidelines. +- [] My Pull Request title is descriptive, accurate and follows the + semantic-release format and guidelines. #### Code @@ -74,9 +82,10 @@ Examples: #### Tested Environment -- [] "OS: [e.g. Windows 10, macOS 10.15.4]" -- [] "Node: [e.g. 16.14.0]" -- [] "Browser: [e.g. Chrome 83.0.4103.116, Firefox 77.0.1, Safari 13.1.1]" +- [] "OS: +- [] "Node version: +- [] "Browser: + [blog]: https://circleci.com/blog/triggering-trusted-ci-jobs-on-untrusted-forks/ From 47724ef10752e2eb635cb581d2a59ec7db99cab5 Mon Sep 17 00:00:00 2001 From: Alireza Date: Wed, 11 Jan 2023 16:38:50 -0500 Subject: [PATCH 6/6] update description --- .github/ISSUE_TEMPLATE/---feature-request.md | 5 +++++ .github/pull_request_template.md | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md index c3360242ae2..cff3c6a96f2 100644 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ b/.github/ISSUE_TEMPLATE/---feature-request.md @@ -20,6 +20,11 @@ assignees: '' ### Request + + **What feature or change would you like to see made?** ... diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 33f5d36d89e..9b9fa9d7aff 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,8 +14,8 @@ To complete the checklist, add an 'x' to each item: [] -> [x] ### Changes & Results