Skip to content

docs: clarify claiming roadmap items before starting work#2079

Merged
hami-robot[bot] merged 3 commits into
Project-HAMi:masterfrom
mesutoezdil:docs/roadmap-item-coordination
Jul 20, 2026
Merged

docs: clarify claiming roadmap items before starting work#2079
hami-robot[bot] merged 3 commits into
Project-HAMi:masterfrom
mesutoezdil:docs/roadmap-item-coordination

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Roadmap tracking issues (like the yearly roadmap) list many items in one checklist, so an item can already be claimed by a comment even with no formal GitHub assignee. This adds one short paragraph to CONTRIBUTING.md making the expected process explicit: comment on the tracking issue and wait for maintainer (@archlitchi) confirmation before starting design or implementation work on a roadmap item.

Summary by CodeRabbit

  • Documentation
    • Added contributor guidance for claiming roadmap checklist items.
    • Clarified that contributors should comment on tracking issues and wait for maintainer confirmation before beginning work.

Roadmap tracking issues list many items in one checklist, so an item
can already be claimed by a comment with no formal assignee. State the
expected process explicitly.

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@hami-robot
hami-robot Bot requested review from archlitchi and wawa0210 July 16, 2026 13:48
@github-actions github-actions Bot added the kind/documentation Improvements or additions to documentation label Jul 16, 2026
@hami-robot hami-robot Bot added the size/XS label Jul 16, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the CONTRIBUTING.md file to clarify the process for claiming roadmap items, instructing contributors to comment on the tracking issue and wait for maintainer confirmation. The review feedback suggests a minor grammatical improvement to add a comma after "e.g." in the newly added text.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread CONTRIBUTING.md Outdated
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Contributor guidance now explains how roadmap checklist items are claimed through comments and requires maintainer confirmation before work begins.

Changes

Roadmap contribution guidance

Layer / File(s) Summary
Claim roadmap checklist items
CONTRIBUTING.md
The “Work on an issue” section explains how to claim roadmap items and wait for maintainer confirmation before starting work.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: wawa0210, archlitchi

Poem

A rabbit reads the roadmap bright,
Claims one checkbox with delight.
A comment marks the chosen trail,
Maintainer nods before we sail.
Then paws begin the coding tale.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the docs update about claiming roadmap items before starting work.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 128-129: Update the roadmap contribution guidance in
CONTRIBUTING.md to explicitly require contributors to wait for confirmation from
`@archlitchi` after commenting to claim an item, before beginning design or
implementation work.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 06939bab-a0e8-4dd7-a453-b033532e31cb

📥 Commits

Reviewing files that changed from the base of the PR and between 03be4d8 and ef35afd.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md
@spencercjh

Copy link
Copy Markdown
Contributor

Indeed, maybe we need to use GitHub Project to manage them.

@archlitchi archlitchi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@hami-robot

hami-robot Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: archlitchi, mesutoezdil

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@hami-robot hami-robot Bot added the approved label Jul 20, 2026
@hami-robot
hami-robot Bot merged commit 2017a45 into Project-HAMi:master Jul 20, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants