From 6b64996986a2c49e48a51360fe6950ec9dd62886 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Wed, 24 Apr 2024 23:26:13 +0200 Subject: [PATCH 01/21] Typo --- .github/workflows/first_time_contributor.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/first_time_contributor.yml b/.github/workflows/first_time_contributor.yml index 4fecb26020a..09c0e8ea8de 100644 --- a/.github/workflows/first_time_contributor.yml +++ b/.github/workflows/first_time_contributor.yml @@ -28,4 +28,6 @@ jobs: FIRST_PR_MERGED_COMMENT: > Congratulations on your first PR merge! 🎉 Thank you for your contribution! We're looking forward to welcome other contributions of yours in the future. @all-contributors please add @{{ author }} for code. - STAR_MESSAGE: If you like Orchard Core, please star our repo and join our [community channels ](https://github.com/OrchardCMS/OrchardCore/?tab=readme-ov-file#get-in-touch) + STAR_MESSAGE: > + If you like Orchard Core, please star our repo and join our + [community channels](https://github.com/OrchardCMS/OrchardCore/?tab=readme-ov-file#get-in-touch). From b8d077dcb4ce0b5e112801778788fe78651aea48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 00:27:44 +0200 Subject: [PATCH 02/21] Closing stale issues automatically too --- ...ale_prs.yml => close_stale_prs_issues.yml} | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) rename .github/workflows/{close_stale_prs.yml => close_stale_prs_issues.yml} (52%) diff --git a/.github/workflows/close_stale_prs.yml b/.github/workflows/close_stale_prs_issues.yml similarity index 52% rename from .github/workflows/close_stale_prs.yml rename to .github/workflows/close_stale_prs_issues.yml index b78897a8809..90e41450b73 100644 --- a/.github/workflows/close_stale_prs.yml +++ b/.github/workflows/close_stale_prs_issues.yml @@ -1,5 +1,6 @@ # Labels PRs without updates for 60 days as stale, then closes them 15 days later. -name: Close stale PRs +# Labels issues that are labeled with "feedback requested" without updates for 15 days as stale, then closes them 7 days later. +name: Close Stale PRs and Issues on: schedule: @@ -7,20 +8,24 @@ on: - cron: '39 1 * * *' jobs: - close-stale-prs: + close-stale-prs-issues: runs-on: ubuntu-latest steps: - uses: actions/stale@v9 with: stale-pr-message: > It seems that this pull request didn't really move for quite a while. Is this something you'd like to - revisit any time soon or should we close? Pleaes comment if you'd like to pick it up and remove the - "stale" label. + revisit any time soon or should we close? Please comment if you'd like to pick it up. stale-pr-label: stale - # Not marking issues as stale. - days-before-issue-stale: -1 # Close the PR 15 days after marking it as stale. - days-before-close: 15 + days-before-pr-close: 15 close-pr-message: > Closing this pull request because it has been stale for very long. If you think this is still relevant, feel free to reopen it. + stale-issue-message: > + It seems that this issue didn't really move for quite a while. Is this something you'd like to revisit + any time soon or should we close? Please reply. + stale-issue-label: stale + days-before-issue-stale: 15 + days-before-issue-close: 7 + only-issue-labels: feedback requested From 6b6fa10bb3bb2fc792dfc54a87456569ac450669 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 00:32:17 +0200 Subject: [PATCH 03/21] Disabling blank issues --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5d71d6dacc5..3793bc9ab4a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Discussions url: https://github.com/OrchardCMS/OrchardCore/discussions/new From 4cfd36a423eea4e35e79358d2a7a429c38ea3a21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 00:56:57 +0200 Subject: [PATCH 04/21] Adding issue management docs --- mkdocs.yml | 1 + src/docs/guides/contributing/README.md | 1 + .../guides/contributing/contributing-code.md | 2 +- .../guides/contributing/managing-issues.md | 36 +++++++++++++++++++ 4 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 src/docs/guides/contributing/managing-issues.md diff --git a/mkdocs.yml b/mkdocs.yml index 44dd824117e..3420503ec86 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -117,6 +117,7 @@ nav: - Create a Liquid Widget: docs/guides/create-liquid-widget/README.md - Query Content Items Based on Taxonomy: docs/guides/query-content-items-based-on-taxonomy/README.md - Contributing: + - Opening and managing issues: docs/guides/contributing/managing-issues.md - Contributing to Orchard Core: docs/guides/contributing/README.md - Contributing code: docs/guides/contributing/contributing-code.md - Contributing documentation: docs/guides/contributing/contributing-documentation.md diff --git a/src/docs/guides/contributing/README.md b/src/docs/guides/contributing/README.md index 75948cb4da0..3bc03c3c0d9 100644 --- a/src/docs/guides/contributing/README.md +++ b/src/docs/guides/contributing/README.md @@ -6,6 +6,7 @@ First of all, thank you for thinking about contributing to Orchard Core! One of the easiest ways to contribute is to participate in discussions under [GitHub issues](https://github.com/OrchardCMS/OrchardCore/issues). You can also contribute by submitting pull requests with code changes, reviewing pull requests by others, assisting other community members on the [discussion board](https://github.com/OrchardCMS/OrchardCore/discussions), [evangelizing Orchard Core](https://github.com/Lombiq/Orchard-Ambassadors-Toolbox) in your own communities, or help organizing events. +- [Opening and managing issues](managing-issues.md) - [Contributing code](contributing-code.md) - [Contributing documentation](contributing-documentation.md) - [Reviewing pull requests](reviewing-pull-requests.md) diff --git a/src/docs/guides/contributing/contributing-code.md b/src/docs/guides/contributing/contributing-code.md index 4da2c94fd97..f82b2c370f1 100644 --- a/src/docs/guides/contributing/contributing-code.md +++ b/src/docs/guides/contributing/contributing-code.md @@ -26,7 +26,7 @@ First, clone the repository using the command `git clone https://github.com/Orch We warmly welcome fixes and features! Here are some resources to help you get started on how to contribute code: -- Check out [the issue tracker](https://github.com/OrchardCMS/OrchardCore/issues) for open bug reports and feature requests. Prefer to select issues [scheduled for the upcoming release](https://github.com/OrchardCMS/OrchardCore/milestones). You can [sort issues by most commented](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) and [most thumbs up](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) (as well as other reactions similarly). These correlate with popularity, i.e. we can see what the community most wants. +- Check out [the issue tracker](https://github.com/OrchardCMS/OrchardCore/issues) for open bug reports and feature requests. Prefer to select issues [scheduled for the upcoming release](https://github.com/OrchardCMS/OrchardCore/milestones) (see the [issue management docs](managing-issues.md#issue-milestones) on what the milestones mean). You can [sort issues by most commented](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) and [most thumbs up](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) (as well as other reactions similarly). These correlate with popularity, i.e. we can see what the community most wants. - ["Good first issue" issues](https://github.com/OrchardCMS/OrchardCore/labels/good%20first%20issue): We think these are a good for newcomers. - ["Help wanted" issues](https://github.com/OrchardCMS/OrchardCore/labels/help%20wanted): These issues are up for grabs. Comment on an issue if you want to create a fix. diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md new file mode 100644 index 00000000000..2e4ad92cedf --- /dev/null +++ b/src/docs/guides/contributing/managing-issues.md @@ -0,0 +1,36 @@ +# Opening and managing issues + +The [issue tracker on GitHub](https://github.com/OrchardCMS/OrchardCore/issues) is where we keep track of bug reports, feature requests, or items for other tasks. We ask you to choose a task from there when you [contribute](README.md); but opening an issue is contribution too, so let's see some tips on that! + +## How to open an issue + +If you found a bug in Orchard Core, or have an idea for a new or improved feature, please open an issue [on GitHub](https://github.com/OrchardCMS/OrchardCore/issues/new/choose). + +- Please select the appropriate type, bug or feature request. This helps us assess your issue better! +- Fill out the template, and please add as many details as possible. If you don't do this, then both you and another contributor will have to take time discussing what your issue is about. + +## What happens after you opened an issue + +We triage issues every week on [the triage meeting](../../resources/meeting/README.md), as well as core contributors may comment on your issue before that. Please reply to any inquiries. + +Once your issue is triaged, one of the following things will happen: + +- A [milestone](https://github.com/OrchardCMS/OrchardCore/milestones) is assigned to it, see below. This means we think your issue is definitely worth addressing, thank you! +- We close it. If your issue is a duplicate of an earlier one, is a report about a bug that's already fixed, or something that we don't think is a good match for Orchard Core, we'll close it with an explanation. This is not against you, it's just that we can't address all issues. Please don't hesitate to open new issues for other matters. + +## Issue milestones + +This is what [issue milestones](https://github.com/OrchardCMS/OrchardCore/milestones) mean: + +- The next patch version (`1.2.something`, e.g. if the current version is `1.2.3`, then `1.2.4`) indicates the highest priority for serious regressions and other urgent bug fixes that we intend to fix ASAP and publish in a patch release. +- The next minor version (`1.something`, e.g. `1.3` if the current version if `1.2.0`) is for less urgent bug fixes and feature requests that we still think should be addressed in the next planned release. Regressions since the last release found by those from the community who live on the edge and use the [preview releases](../../getting-started/preview-package-source.md) are marked as such too. +- Some later minor version (literally `1.x` if the current version is `1.anything`) is for issues that we intend to address eventually, maybe. +- The `backlog` milestone is for everything else that we think is a valid request but won't work on it any time soon. + +## Managing issues as a core contributor + +Some tips on issue management: + +- Set the milestone according to the above logic, or close the issue with a comment elaborating the reason. +- Add further labels for categorization (external contributors can't add labels). +- If you asked the author something and the issue should be closed if they don't reply, add the `feedback requested` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. \ No newline at end of file From 24389e63b5fca3e0ee38f07e0471141f03dc5d3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 00:59:02 +0200 Subject: [PATCH 05/21] Linking issue management docs from issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d731eaa44cc..d2ed54a382a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,6 +6,7 @@ labels: 'bug :bug:' assignees: '' --- + ### Describe the bug diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 174f9b33193..67f097aa81e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,6 +6,7 @@ labels: enhancement assignees: '' --- + ### Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. From 9391ee24bb650f174fdac9bb1e687e24e0837485 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 01:11:38 +0200 Subject: [PATCH 06/21] Adding workflow to comment on milestone change --- .github/workflows/comment_issue_on_triage.yml | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/comment_issue_on_triage.yml diff --git a/.github/workflows/comment_issue_on_triage.yml b/.github/workflows/comment_issue_on_triage.yml new file mode 100644 index 00000000000..bc9bc7ccd66 --- /dev/null +++ b/.github/workflows/comment_issue_on_triage.yml @@ -0,0 +1,31 @@ +# Adds a comment on the issue when its milestone is set. +name: Comment Issue on Triage + +on: + issues: + # Note that this is triggered also when the milestone changes. Preventing that would require jumping through a lot + # of hoops, and that should be rare anyway. + types: [milestoned] + +jobs: + comment-issue-on-triage: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - name: Add Comment + run: gh issue comment "$NUMBER" --body "$BODY" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_REPO: ${{ github.repository }} + NUMBER: ${{ github.event.issue.number }} + # The double empty lines in the body are necessary; it'll show up as a single empty line in the comment. + BODY: > + Thank you for submitting this issue! We triaged it and set the milestone according to the priority we think + is appropriate (see [the docs](https://docs.orchardcore.net/en/latest/docs/guides/contributing/managing-issues/) + on how we triage and prioritize issues). + + + This indicates when the core team may start working on it. However, if you'd like to contribute, we'd + warmly welcome you to do that anytime. See our guide on contributions + [here](https://docs.orchardcore.net/en/latest/docs/guides/contributing/). From 99cb59ea0167356c14f1401d065b6cccd1e875cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 01:20:06 +0200 Subject: [PATCH 07/21] Removing trailing space --- src/docs/guides/contributing/contributing-code.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/contributing-code.md b/src/docs/guides/contributing/contributing-code.md index f82b2c370f1..368e21911c1 100644 --- a/src/docs/guides/contributing/contributing-code.md +++ b/src/docs/guides/contributing/contributing-code.md @@ -26,7 +26,7 @@ First, clone the repository using the command `git clone https://github.com/Orch We warmly welcome fixes and features! Here are some resources to help you get started on how to contribute code: -- Check out [the issue tracker](https://github.com/OrchardCMS/OrchardCore/issues) for open bug reports and feature requests. Prefer to select issues [scheduled for the upcoming release](https://github.com/OrchardCMS/OrchardCore/milestones) (see the [issue management docs](managing-issues.md#issue-milestones) on what the milestones mean). You can [sort issues by most commented](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) and [most thumbs up](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) (as well as other reactions similarly). These correlate with popularity, i.e. we can see what the community most wants. +- Check out [the issue tracker](https://github.com/OrchardCMS/OrchardCore/issues) for open bug reports and feature requests. Prefer to select issues [scheduled for the upcoming release](https://github.com/OrchardCMS/OrchardCore/milestones) (see the [issue management docs](managing-issues.md#issue-milestones) on what the milestones mean). You can [sort issues by most commented](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) and [most thumbs up](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) (as well as other reactions similarly). These correlate with popularity, i.e. we can see what the community most wants. - ["Good first issue" issues](https://github.com/OrchardCMS/OrchardCore/labels/good%20first%20issue): We think these are a good for newcomers. - ["Help wanted" issues](https://github.com/OrchardCMS/OrchardCore/labels/help%20wanted): These issues are up for grabs. Comment on an issue if you want to create a fix. From 634f3c09643352a6d986f473cddf9cad5ce5d0a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 02:20:01 +0200 Subject: [PATCH 08/21] Referring to documentation issues --- src/docs/guides/contributing/contributing-code.md | 1 + src/docs/guides/contributing/contributing-documentation.md | 3 +++ 2 files changed, 4 insertions(+) diff --git a/src/docs/guides/contributing/contributing-code.md b/src/docs/guides/contributing/contributing-code.md index 368e21911c1..c407eb2ba25 100644 --- a/src/docs/guides/contributing/contributing-code.md +++ b/src/docs/guides/contributing/contributing-code.md @@ -29,6 +29,7 @@ We warmly welcome fixes and features! Here are some resources to help you get st - Check out [the issue tracker](https://github.com/OrchardCMS/OrchardCore/issues) for open bug reports and feature requests. Prefer to select issues [scheduled for the upcoming release](https://github.com/OrchardCMS/OrchardCore/milestones) (see the [issue management docs](managing-issues.md#issue-milestones) on what the milestones mean). You can [sort issues by most commented](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) and [most thumbs up](https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) (as well as other reactions similarly). These correlate with popularity, i.e. we can see what the community most wants. - ["Good first issue" issues](https://github.com/OrchardCMS/OrchardCore/labels/good%20first%20issue): We think these are a good for newcomers. - ["Help wanted" issues](https://github.com/OrchardCMS/OrchardCore/labels/help%20wanted): These issues are up for grabs. Comment on an issue if you want to create a fix. +- [Documentation issues](https://github.com/OrchardCMS/OrchardCore/labels/documentation) are quite suitable for newcomers too. See the [docs on contributing documentation](contributing-documentation.md). ## Identifying the scale diff --git a/src/docs/guides/contributing/contributing-documentation.md b/src/docs/guides/contributing/contributing-documentation.md index 4ba1af95592..43a694b02aa 100644 --- a/src/docs/guides/contributing/contributing-documentation.md +++ b/src/docs/guides/contributing/contributing-documentation.md @@ -7,6 +7,9 @@ The [Orchard Core documentation site](https://docs.orchardcore.net/) is built wi !!! info Are you looking for information on contributing code? Head over to [here](contributing-code.md) instead. +!!! tip + If you're looking for ideas on what to improve in the Orchard Core documentation, check out the [documentation issues](https://github.com/OrchardCMS/OrchardCore/labels/documentation). + ## Editing documentation pages First, clone the repository using the command `git clone https://github.com/OrchardCMS/OrchardCore.git` and checkout the `main` branch. You can find the documentation files under the `src/docs` folder. From 7458dc982bfcb3f24c650ac1b962f199469534d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 14:32:52 +0200 Subject: [PATCH 09/21] Add close issue message too --- .github/workflows/close_stale_prs_issues.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/close_stale_prs_issues.yml b/.github/workflows/close_stale_prs_issues.yml index 90e41450b73..15c6e0d4e5d 100644 --- a/.github/workflows/close_stale_prs_issues.yml +++ b/.github/workflows/close_stale_prs_issues.yml @@ -29,3 +29,6 @@ jobs: days-before-issue-stale: 15 days-before-issue-close: 7 only-issue-labels: feedback requested + close-issue-message: > + Closing this issue because it has been stale for very long. If you think this is still relevant, + feel free to reopen it. From e5f89288d28a9009b5e17e2a7334a75f38499471 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 14:33:18 +0200 Subject: [PATCH 10/21] Adjust triage issue message so it's suitable also when the milestone changes --- .github/workflows/comment_issue_on_triage.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/comment_issue_on_triage.yml b/.github/workflows/comment_issue_on_triage.yml index bc9bc7ccd66..ec37d02dbdd 100644 --- a/.github/workflows/comment_issue_on_triage.yml +++ b/.github/workflows/comment_issue_on_triage.yml @@ -21,9 +21,9 @@ jobs: NUMBER: ${{ github.event.issue.number }} # The double empty lines in the body are necessary; it'll show up as a single empty line in the comment. BODY: > - Thank you for submitting this issue! We triaged it and set the milestone according to the priority we think - is appropriate (see [the docs](https://docs.orchardcore.net/en/latest/docs/guides/contributing/managing-issues/) - on how we triage and prioritize issues). + We triaged this issue and set the milestone according to the priority we think is appropriate (see + [the docs](https://docs.orchardcore.net/en/latest/docs/guides/contributing/managing-issues/) on how we + triage and prioritize issues). This indicates when the core team may start working on it. However, if you'd like to contribute, we'd From 98e2482828cf2d80391e9024b203fd071f813db9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 21:08:59 +0200 Subject: [PATCH 11/21] Change feedback request label to what we use already --- .github/workflows/close_stale_prs_issues.yml | 4 ++-- src/docs/guides/contributing/managing-issues.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/close_stale_prs_issues.yml b/.github/workflows/close_stale_prs_issues.yml index 15c6e0d4e5d..b85f9ffbc65 100644 --- a/.github/workflows/close_stale_prs_issues.yml +++ b/.github/workflows/close_stale_prs_issues.yml @@ -1,5 +1,5 @@ # Labels PRs without updates for 60 days as stale, then closes them 15 days later. -# Labels issues that are labeled with "feedback requested" without updates for 15 days as stale, then closes them 7 days later. +# Labels issues that are labeled with "needs author feedback" without updates for 15 days as stale, then closes them 7 days later. name: Close Stale PRs and Issues on: @@ -28,7 +28,7 @@ jobs: stale-issue-label: stale days-before-issue-stale: 15 days-before-issue-close: 7 - only-issue-labels: feedback requested + only-issue-labels: needs author feedback close-issue-message: > Closing this issue because it has been stale for very long. If you think this is still relevant, feel free to reopen it. diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index 2e4ad92cedf..29eb3daf212 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -33,4 +33,4 @@ Some tips on issue management: - Set the milestone according to the above logic, or close the issue with a comment elaborating the reason. - Add further labels for categorization (external contributors can't add labels). -- If you asked the author something and the issue should be closed if they don't reply, add the `feedback requested` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. \ No newline at end of file +- If you asked the author something and the issue should be closed if they don't reply, add the `needs author feedback` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. \ No newline at end of file From 9d30914a49f4564c0d76bc08c748421925ce410a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 21:45:06 +0200 Subject: [PATCH 12/21] Grammar Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- src/docs/guides/contributing/managing-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index 29eb3daf212..cea4c3c88b2 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -25,7 +25,7 @@ This is what [issue milestones](https://github.com/OrchardCMS/OrchardCore/milest - The next patch version (`1.2.something`, e.g. if the current version is `1.2.3`, then `1.2.4`) indicates the highest priority for serious regressions and other urgent bug fixes that we intend to fix ASAP and publish in a patch release. - The next minor version (`1.something`, e.g. `1.3` if the current version if `1.2.0`) is for less urgent bug fixes and feature requests that we still think should be addressed in the next planned release. Regressions since the last release found by those from the community who live on the edge and use the [preview releases](../../getting-started/preview-package-source.md) are marked as such too. - Some later minor version (literally `1.x` if the current version is `1.anything`) is for issues that we intend to address eventually, maybe. -- The `backlog` milestone is for everything else that we think is a valid request but won't work on it any time soon. +- The `backlog` milestone is for everything else that we think is a valid request, but won't work on it any time soon. ## Managing issues as a core contributor From b02502ef16af8aa21f484b776ad56b80199338e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 21:45:32 +0200 Subject: [PATCH 13/21] Grammar Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- src/docs/guides/contributing/managing-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index cea4c3c88b2..f211e7f570c 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -1,6 +1,6 @@ # Opening and managing issues -The [issue tracker on GitHub](https://github.com/OrchardCMS/OrchardCore/issues) is where we keep track of bug reports, feature requests, or items for other tasks. We ask you to choose a task from there when you [contribute](README.md); but opening an issue is contribution too, so let's see some tips on that! +The [issue tracker on GitHub](https://github.com/OrchardCMS/OrchardCore/issues) is where we keep track of bug reports, feature requests, or items for other tasks. We ask you to choose a task from there when you [contribute](README.md), but opening an issue is contribution too, so let's see some tips on that! ## How to open an issue From 11a4fef05598328dec8d9ee286c155d902559eb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 21:45:44 +0200 Subject: [PATCH 14/21] End of file line break Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- src/docs/guides/contributing/managing-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index f211e7f570c..311da6dfd41 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -33,4 +33,4 @@ Some tips on issue management: - Set the milestone according to the above logic, or close the issue with a comment elaborating the reason. - Add further labels for categorization (external contributors can't add labels). -- If you asked the author something and the issue should be closed if they don't reply, add the `needs author feedback` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. \ No newline at end of file +- If you asked the author something and the issue should be closed if they don't reply, add the `needs author feedback` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. From 26ac0f68b7d56b157a3ce3145154ed7fa231bccc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 21:50:35 +0200 Subject: [PATCH 15/21] Grammar Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- src/docs/guides/contributing/managing-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index 311da6dfd41..83812875789 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -9,7 +9,7 @@ If you found a bug in Orchard Core, or have an idea for a new or improved featur - Please select the appropriate type, bug or feature request. This helps us assess your issue better! - Fill out the template, and please add as many details as possible. If you don't do this, then both you and another contributor will have to take time discussing what your issue is about. -## What happens after you opened an issue +## What happens after you open an issue We triage issues every week on [the triage meeting](../../resources/meeting/README.md), as well as core contributors may comment on your issue before that. Please reply to any inquiries. From 1bf3c710d61b443fe9bb097a19144566628acaa0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 25 Apr 2024 23:47:36 +0200 Subject: [PATCH 16/21] Adding notes about issue labels --- src/docs/guides/contributing/managing-issues.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index 83812875789..17109475718 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -32,5 +32,9 @@ This is what [issue milestones](https://github.com/OrchardCMS/OrchardCore/milest Some tips on issue management: - Set the milestone according to the above logic, or close the issue with a comment elaborating the reason. -- Add further labels for categorization (external contributors can't add labels). +- Add further labels for categorization (external contributors can't add labels). E.g.: + - Add "good first issue" if the issues looks suitable for a novice contributor. + - Add "perf" if it's about performance. + - Add module/feature set-related labels, like "Media" or "OpenId". + - Add "security" for security issues. - If you asked the author something and the issue should be closed if they don't reply, add the `needs author feedback` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. From 0a7223a879416bdfc4a089b0f929b69849dca4b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Fri, 26 Apr 2024 00:14:45 +0200 Subject: [PATCH 17/21] Grammar Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- src/docs/guides/contributing/managing-issues.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index 17109475718..59a91ac6010 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -1,10 +1,10 @@ # Opening and managing issues -The [issue tracker on GitHub](https://github.com/OrchardCMS/OrchardCore/issues) is where we keep track of bug reports, feature requests, or items for other tasks. We ask you to choose a task from there when you [contribute](README.md), but opening an issue is contribution too, so let's see some tips on that! +The [issue tracker on GitHub](https://github.com/OrchardCMS/OrchardCore/issues) is where we keep track of bug reports, feature requests, or items for other tasks. We ask you to choose a task from there when you [contribute](README.md), but opening an issue is a contribution too, so let's see some tips on that! ## How to open an issue -If you found a bug in Orchard Core, or have an idea for a new or improved feature, please open an issue [on GitHub](https://github.com/OrchardCMS/OrchardCore/issues/new/choose). +If you find a bug in Orchard Core, or have an idea for a new or improved feature, please open an issue [on GitHub](https://github.com/OrchardCMS/OrchardCore/issues/new/choose). - Please select the appropriate type, bug or feature request. This helps us assess your issue better! - Fill out the template, and please add as many details as possible. If you don't do this, then both you and another contributor will have to take time discussing what your issue is about. @@ -33,7 +33,7 @@ Some tips on issue management: - Set the milestone according to the above logic, or close the issue with a comment elaborating the reason. - Add further labels for categorization (external contributors can't add labels). E.g.: - - Add "good first issue" if the issues looks suitable for a novice contributor. + - Add "good first issue" if the issue looks suitable for a novice contributor. - Add "perf" if it's about performance. - Add module/feature set-related labels, like "Media" or "OpenId". - Add "security" for security issues. From 045f8593b827e4dd108666a1522b4c5ea71e2c34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Fri, 26 Apr 2024 00:33:45 +0200 Subject: [PATCH 18/21] Note about converting issues to discussions --- src/docs/guides/contributing/managing-issues.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index 59a91ac6010..e3dadacaa21 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -25,12 +25,13 @@ This is what [issue milestones](https://github.com/OrchardCMS/OrchardCore/milest - The next patch version (`1.2.something`, e.g. if the current version is `1.2.3`, then `1.2.4`) indicates the highest priority for serious regressions and other urgent bug fixes that we intend to fix ASAP and publish in a patch release. - The next minor version (`1.something`, e.g. `1.3` if the current version if `1.2.0`) is for less urgent bug fixes and feature requests that we still think should be addressed in the next planned release. Regressions since the last release found by those from the community who live on the edge and use the [preview releases](../../getting-started/preview-package-source.md) are marked as such too. - Some later minor version (literally `1.x` if the current version is `1.anything`) is for issues that we intend to address eventually, maybe. -- The `backlog` milestone is for everything else that we think is a valid request, but won't work on it any time soon. +- The `backlog` milestone is for everything else that we think is a valid request, but we won't work on it any time soon. ## Managing issues as a core contributor Some tips on issue management: +- An issue should be about a concrete task, some change in Orchard Core or how we run the project. If it's a question or discussion, then [convert it into a discussion](https://docs.github.com/en/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion). - Set the milestone according to the above logic, or close the issue with a comment elaborating the reason. - Add further labels for categorization (external contributors can't add labels). E.g.: - Add "good first issue" if the issue looks suitable for a novice contributor. From 8a385378944a88046d9f5b72820ae7f877a167cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Fri, 26 Apr 2024 16:41:08 +0200 Subject: [PATCH 19/21] Adding note about changing issue and PR titles --- src/docs/guides/contributing/managing-issues.md | 1 + src/docs/guides/contributing/reviewing-pull-requests.md | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/docs/guides/contributing/managing-issues.md b/src/docs/guides/contributing/managing-issues.md index e3dadacaa21..ddee911bf96 100644 --- a/src/docs/guides/contributing/managing-issues.md +++ b/src/docs/guides/contributing/managing-issues.md @@ -38,4 +38,5 @@ Some tips on issue management: - Add "perf" if it's about performance. - Add module/feature set-related labels, like "Media" or "OpenId". - Add "security" for security issues. +- Change the issue's title if it contains errors or is unclear/incorrect. - If you asked the author something and the issue should be closed if they don't reply, add the `needs author feedback` label. This will automatically mark the issue as stale after 15 days, and then close it after another 7. diff --git a/src/docs/guides/contributing/reviewing-pull-requests.md b/src/docs/guides/contributing/reviewing-pull-requests.md index 1b59f6438ae..330f21bccf1 100644 --- a/src/docs/guides/contributing/reviewing-pull-requests.md +++ b/src/docs/guides/contributing/reviewing-pull-requests.md @@ -16,9 +16,10 @@ If the PR is coming from a fork, working with its code locally won't be as trivi ## Tips on managing pull requests !!! note - Adding labels and merging pull requests is only available for core contributors. Otherwise, anybody can review pull requests. + Adding labels and otherwise updating a pull request, as well as merging them are only available for core contributors. Otherwise, anybody can review the changes in pull requests and comment on them. -- [Here's a list](https://github.com/OrchardCMS/OrchardCore/pulls?q=is%3Apr+is%3Aopen+reviewed-by%3A%40me) of open PRs reviewed by you. Maybe check them because perhaps it's time to ping the authors since maybe they forgot to follow up. Or maybe you forgot to merge a PR? +- [Here's a list](https://github.com/OrchardCMS/OrchardCore/pulls?q=is%3Apr+is%3Aopen+reviewed-by%3A%40me) of open PRs reviewed by you. Maybe check them because perhaps it's time to ping the authors since maybe they forgot to follow up. Or maybe you forgot to merge a PR? +- Change the PR's title if it contains errors or is unclear/incorrect. - Add the "don't merge" label on PRs that are ready for review, approved by you and/or others, but you asked more people for feedback before it can be merged. - Add the "needs triage" label on PRs that you think should be checked by others during the weekly triage meeting too. Explain in a comment why you deem this is necessary. - Be sure to merge PRs that don't need a second opinion. This is especially important for external contributors who can't merge their PRs. Keeping PRs open will make them collect merge conflicts and make the contributor demotivated. From ada1b47953d3caea795c83ac325030c48554cc74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Fri, 26 Apr 2024 16:46:23 +0200 Subject: [PATCH 20/21] Only run workflow for open issues --- .github/workflows/comment_issue_on_triage.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/comment_issue_on_triage.yml b/.github/workflows/comment_issue_on_triage.yml index ec37d02dbdd..1ad96dfa4a2 100644 --- a/.github/workflows/comment_issue_on_triage.yml +++ b/.github/workflows/comment_issue_on_triage.yml @@ -12,6 +12,7 @@ jobs: runs-on: ubuntu-latest permissions: issues: write + if: github.event.issue.state == 'open' steps: - name: Add Comment run: gh issue comment "$NUMBER" --body "$BODY" From a8ceaa082f17185d3c312b7bcee8067949dd7007 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Thu, 23 May 2024 19:58:58 +0200 Subject: [PATCH 21/21] Grammar MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sébastien Ros --- .github/workflows/first_time_contributor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/first_time_contributor.yml b/.github/workflows/first_time_contributor.yml index c52a71743e3..23b16752367 100644 --- a/.github/workflows/first_time_contributor.yml +++ b/.github/workflows/first_time_contributor.yml @@ -26,7 +26,7 @@ jobs: guide provides helpful information to ensure your contribution aligns with our standards. A core team member will review your pull request. FIRST_PR_MERGED_COMMENT: > - Congratulations on your first PR merge! 🎉 Thank you for your contribution! We're looking forward to welcome + Congratulations on your first PR merge! 🎉 Thank you for your contribution! We're looking forward to welcoming other contributions of yours in the future. @all-contributors please add @{{ author }} for code. STAR_MESSAGE: > If you like Orchard Core, please star our repo and join our