Issue management docs, auto-close and triage comment workflow (Lombiq Technologies: OCORE-161) #15820

Piedone · 2024-04-24T23:13:25Z

coderabbitai · 2024-04-24T23:13:33Z

Note

Reviews Paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Walkthrough

The changes primarily focus on enhancing issue and pull request management in the OrchardCore project. This includes updates to GitHub workflows and templates to improve automation, communication, and clarity in handling issues and PRs. Additionally, documentation has been expanded and updated to guide contributors more effectively.

Changes

File Path	Change Summary
`.github/ISSUE_TEMPLATE/...`	Added guidance for issue management in templates
`.github/workflows/...`	Updated workflows to handle stale issues/PRs and add comments on triage
`mkdocs.yml`, `src/docs/guides/contributing/...`	Updated and added documentation sections on issue management and contributing

Assessment against linked issues

Objective	Addressed	Explanation
Triage all yet untriaged issues (#15034)	❓	It's unclear if all untriaged issues are addressed, but workflows and documentation updates support ongoing triage efforts.
Document issue management and prioritization clearly (#15034)	✅
Automatically add comments when issues are triaged (#15034)	✅
Automatically close issues with no feedback from the author (#15034)	✅
Remove and simplify priority labels to use milestones only (#15034)	✅

Possibly related issues

CodeRabbit for AI code reviews #15439: This issue discusses integrating an AI tool for code reviews to address PRs sitting open for too long. The changes made in the PR regarding improved automation and documentation for handling PRs could indirectly support the objectives of issue CodeRabbit for AI code reviews #15439 by making the review process more efficient.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Piedone · 2024-04-24T23:13:55Z

.github/workflows/comment_issue_on_triage.yml

This is how this looks like: https://github.com/Lombiq/OCORE-161-workflows-test/issues/3.

Piedone · 2024-04-24T23:14:20Z

src/docs/guides/contributing/managing-issues.md

+- 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


We have these P0-P3 labels, I assume P0 meaning the most important and P3 the least important issues. A small fraction of the issues are marked as such, though. I'd just remove these and only use milestones. OK to remove them?

Piedone · 2024-04-24T23:17:07Z

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-blank_issues_enabled: true
+blank_issues_enabled: false


There are almost 500 issues without labels, because we didn't enforce the very rudimentary task of making the author select if their issue is a bug or feature request. This makes managing those issues a lot harder.

I'd actually also enforce the templates too (like this one). Currently, you can just remove the template and write into the issue description whatever. This requires the one replying to the issue ask the same questions.

What do you think?

Piedone · 2024-04-24T23:17:37Z

.github/workflows/close_stale_prs_issues.yml

-            revisit any time soon or should we close? Pleaes comment if you'd like to pick it up and remove the 
-            "stale" label.


The "stale" label is actually removed automatically.

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

src/docs/guides/contributing/contributing-code.md (1)

29-29: Consider removing trailing spaces for cleaner Markdown formatting.

…changes

coderabbitai

Actionable comments posted: 3

src/docs/guides/contributing/managing-issues.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 3

src/docs/guides/contributing/managing-issues.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 1

src/docs/guides/contributing/managing-issues.md

coderabbitai

Actionable comments posted: 6

src/docs/guides/contributing/managing-issues.md

coderabbitai

Actionable comments posted: 2

src/docs/guides/contributing/managing-issues.md

coderabbitai

Actionable comments posted: 3

src/docs/guides/contributing/managing-issues.md

Piedone · 2024-04-25T22:48:01Z

@coderabbitai stop

coderabbitai · 2024-04-25T22:48:17Z

Tip

For best results, initiate chat on the files or code changes.

@Piedone, I've stopped all actions as requested. If there's anything else you need, feel free to let me know.

coderabbitai

Actionable comments posted: 1

src/docs/guides/contributing/managing-issues.md

Piedone · 2024-04-26T15:00:37Z

@coderabbitai pause

github-actions · 2024-04-28T19:45:20Z

This pull request has merge conflicts. Please resolve those before requesting a review.

# Conflicts: # mkdocs.yml

github-actions · 2024-05-13T20:15:00Z

This pull request has merge conflicts. Please resolve those before requesting a review.

# Conflicts: # .github/workflows/close_stale_prs.yml

Piedone · 2024-05-17T22:45:40Z

Can I get a review here from one of you @hishamco @MikeAlhayek @sebastienros? This has been sitting here for weeks. Also see the comments I've added above.

.github/workflows/first_time_contributor.yml

Co-authored-by: Sébastien Ros <sebastienros@gmail.com>

Piedone · 2024-05-24T13:57:51Z

@hishamco @MikeAlhayek @sebastienros If you asked the author something and the issue should be closed if they don't reply, now you can add the needs author feedback label. This will automatically mark the issue as stale after 15 days, and then close it after another 7.

Piedone added 7 commits April 24, 2024 23:26

Typo

6b64996

Merge remote-tracking branch 'official/main' into issue/OCORE-161

664db8d

Closing stale issues automatically too

b8d077d

Disabling blank issues

6b6fa10

Adding issue management docs

4cfd36a

Linking issue management docs from issue templates

24389e6

Adding workflow to comment on milestone change

9391ee2

Piedone commented Apr 24, 2024

View reviewed changes

coderabbitai bot reviewed Apr 24, 2024

View reviewed changes

Piedone mentioned this pull request Apr 24, 2024

Get our issue management game in order #15034

Closed

8 tasks

Piedone added 5 commits April 25, 2024 01:20

Removing trailing space

99cb59e

Referring to documentation issues

634f3c0

Add close issue message too

7458dc9

Adjust triage issue message so it's suitable also when the milestone …

e5f8928

…changes

Change feedback request label to what we use already

98e2482

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

Piedone and others added 3 commits April 25, 2024 21:45

Grammar

9d30914

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Grammar

b02502e

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

End of file line break

11a4fef

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

Grammar

26ac0f6

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

Piedone commented Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

Adding notes about issue labels

1bf3c71

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

Piedone commented Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Show resolved Hide resolved

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Outdated Show resolved Hide resolved

src/docs/guides/contributing/managing-issues.md Show resolved Hide resolved

Note about converting issues to discussions

045f859

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Show resolved Hide resolved

src/docs/guides/contributing/managing-issues.md Show resolved Hide resolved

Piedone added 2 commits April 26, 2024 16:41

Adding note about changing issue and PR titles

8a38537

Only run workflow for open issues

ada1b47

coderabbitai bot reviewed Apr 26, 2024

View reviewed changes

src/docs/guides/contributing/managing-issues.md Show resolved Hide resolved

github-actions bot added the merge conflict label Apr 28, 2024

Merge remote-tracking branch 'official/main' into issue/OCORE-161

f2cc0b1

# Conflicts: # mkdocs.yml

github-actions bot removed the merge conflict label Apr 28, 2024

This was referenced May 1, 2024

Monthly community metrics report for 2024-04-01..2024-04-30 #15929

Open

Monthly community metrics report for 2024-04-01..2024-04-30 Emmanjr/OrchardCore#2

Open

Piedone requested review from hishamco and MikeAlhayek May 2, 2024 18:10

Piedone mentioned this pull request May 13, 2024

"Pleaes" typo in Close stale PRs workflow (Lombiq Technologies: OCORE-168) #16045

Merged

github-actions bot added the merge conflict label May 13, 2024

Merge remote-tracking branch 'official/main' into issue/OCORE-161

4d60a96

# Conflicts: # .github/workflows/close_stale_prs.yml

github-actions bot removed the merge conflict label May 13, 2024

Piedone requested a review from sebastienros May 14, 2024 12:53

Merge remote-tracking branch 'origin/main' into issue/OCORE-161

0419f81

sebastienros reviewed May 23, 2024

View reviewed changes

.github/workflows/first_time_contributor.yml Outdated Show resolved Hide resolved

sebastienros approved these changes May 23, 2024

View reviewed changes

Grammar

a8ceaa0

Co-authored-by: Sébastien Ros <sebastienros@gmail.com>

MikeAlhayek merged commit 98bca75 into OrchardCMS:main May 23, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue management docs, auto-close and triage comment workflow (Lombiq Technologies: OCORE-161) #15820

Issue management docs, auto-close and triage comment workflow (Lombiq Technologies: OCORE-161) #15820

Piedone commented Apr 24, 2024

coderabbitai bot commented Apr 24, 2024 •

edited

Reviews Paused

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Piedone Apr 24, 2024

Piedone Apr 24, 2024

Piedone Apr 24, 2024 •

edited

Piedone Apr 24, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

Piedone commented Apr 25, 2024

coderabbitai bot commented Apr 25, 2024

coderabbitai bot left a comment

Piedone commented Apr 26, 2024

github-actions bot commented Apr 28, 2024

github-actions bot commented May 13, 2024

Piedone commented May 17, 2024

Piedone commented May 24, 2024

		@@ -1,4 +1,4 @@
		blank_issues_enabled: true
		blank_issues_enabled: false

		revisit any time soon or should we close? Pleaes comment if you'd like to pick it up and remove the
		"stale" label.

Issue management docs, auto-close and triage comment workflow (Lombiq Technologies: OCORE-161) #15820

Issue management docs, auto-close and triage comment workflow (Lombiq Technologies: OCORE-161) #15820

Conversation

Piedone commented Apr 24, 2024

coderabbitai bot commented Apr 24, 2024 • edited

Reviews Paused

Walkthrough

Changes

Assessment against linked issues

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Piedone Apr 24, 2024

Choose a reason for hiding this comment

Piedone Apr 24, 2024

Choose a reason for hiding this comment

Piedone Apr 24, 2024 • edited

Choose a reason for hiding this comment

Piedone Apr 24, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

Piedone commented Apr 25, 2024

coderabbitai bot commented Apr 25, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

Piedone commented Apr 26, 2024

github-actions bot commented Apr 28, 2024

github-actions bot commented May 13, 2024

Piedone commented May 17, 2024

Piedone commented May 24, 2024

coderabbitai bot commented Apr 24, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

Piedone Apr 24, 2024 •

edited