Skip to content

docs: use sub-issues to link Problems to Goals#98

Merged
zolotokrylin merged 23 commits intomainfrom
docs/problem-goal-sub-issue-linking
Apr 10, 2026
Merged

docs: use sub-issues to link Problems to Goals#98
zolotokrylin merged 23 commits intomainfrom
docs/problem-goal-sub-issue-linking

Conversation

@zolotokrylin
Copy link
Copy Markdown
Member

@zolotokrylin zolotokrylin commented Apr 10, 2026

Summary

  • Replaces the manual list-item link in the Goal description with GitHub's native sub-issue relationship
  • Keeps the Goal link in the Problem description for reverse navigation

Why

Using sub-issues establishes a real structural parent-child relationship — it shows up in the Goal issue's UI, tracks completion automatically, and is unambiguous. Manually adding a list-item link in the Goal description is redundant and tends to go stale.

Summary by CodeRabbit

  • Documentation
    • Updated Code of Conduct with restructured Rules section covering ownership, communication, and async-first work guidelines with core hours (2–6 PM HKT)
    • Enhanced Contributing guide with communication guidelines, expanded PR requirements, and clarified review process
    • Introduced Referral Program documentation outlining contributor and business referral eligibility criteria
    • Reorganized documentation structure and references

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 10, 2026

Warning

Rate limit exceeded

@zolotokrylin has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 9 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 16 minutes and 9 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 515096b7-5ab2-4f35-8241-a0212f9be1ee

📥 Commits

Reviewing files that changed from the base of the PR and between 8c3036b and 68a8ab3.

📒 Files selected for processing (2)
  • .gitignore
  • docs/CONTRIBUTING.md

Walkthrough

Documentation restructuring consolidates governance principles from a standalone PRINCIPLES.md into CODE_OF_CONDUCT.md, expands CONTRIBUTING.md with detailed PR requirements and review process guidance, removes PRINCIPLES.md, adds REFERRAL.md for referral program rules, updates README links, and updates a Git submodule reference.

Changes

Cohort / File(s) Summary
Documentation Index
README.md
Removed "Principles" link from "Align with" list; added "Referral Program" link to ./docs/REFERRAL.md.
Governance & Conduct
docs/CODE_OF_CONDUCT.md
Restructured with new "Rules" section containing Ownership, Communication, and Availability sub-sections. Added async-first work requirement and core-hours availability (2–6 PM HKT). Standardized quotation marks in Core Values.
Contribution Process
docs/CONTRIBUTING.md
Added Table of Contents and new sections (Communication Guidelines, PR Requirements, PR Lifecycle, Review Process). Updated Goal/Problem workflow to use GitHub sub-issues instead of in-Goal status updates. Expanded PR checklist with signed commits, scope fit, CI pass, reviewer assignment, time reporting, and title conventions. Refined Review Process to distinguish "Request Changes" (blockers) from "Comment" (non-blocking).
Removed Documentation
docs/PRINCIPLES.md
File fully deleted; content consolidated into CODE_OF_CONDUCT.md.
New Referral Program
docs/REFERRAL.md
New documentation defining referral program rules for Contributors and Business categories, eligibility criteria (3+ months activity), registration requirement (referrer named at application time), and commercial agreement override clause.
Submodule Update
.claude/worktrees/practical-babbage
Updated submodule commit reference to 77a4742269171974ee5919c0376a5e894e7f27a4.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • markholdex
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly matches the PR's primary objective: switching documentation to use GitHub sub-issues for linking Problems to Goals, which is the main change across multiple documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/problem-goal-sub-issue-linking

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 and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.claude/worktrees/practical-babbage:
- Line 1: Remove the local worktree artifact
".claude/worktrees/practical-babbage" from this PR: delete the file/dir from the
branch (or remove it from the commit), add the ".claude/" pattern to .gitignore
to prevent future inclusion, and amend or create a new commit so the change no
longer appears in the PR (the offending commit is
77a4742269171974ee5919c0376a5e894e7f27a4). Ensure the PR contains only
source/docs content and that the worktree metadata is not tracked going forward.

In `@docs/CONTRIBUTING.md`:
- Line 169: The CONTRIBUTING guidelines are inconsistent about whether the PR
title scope is required: update the two occurrences so they match by choosing
one canonical format (either require scope using `type(scope): action` or allow
optional scope using `type(scope [Optional]): action`) and then replace both
instances (the checklist item `[ ] PR title follows `type(scope): action`` and
the Naming section example `type(scope [Optional]): action`) to use the chosen
format so the rules are unambiguous.
🪄 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

Run ID: 4a010dab-9c41-402d-b942-ec9022bd0f92

📥 Commits

Reviewing files that changed from the base of the PR and between b50b4f0 and 8c3036b.

📒 Files selected for processing (6)
  • .claude/worktrees/practical-babbage
  • README.md
  • docs/CODE_OF_CONDUCT.md
  • docs/CONTRIBUTING.md
  • docs/PRINCIPLES.md
  • docs/REFERRAL.md
💤 Files with no reviewable changes (1)
  • docs/PRINCIPLES.md

Comment thread .claude/worktrees/practical-babbage
Comment thread docs/CONTRIBUTING.md
@holdex
Copy link
Copy Markdown

holdex bot commented Apr 10, 2026

Time Submission Status

Member Status Time Action Last Update
zolotokrylin ✅ Submitted 1h Update time Apr 10, 2026, 8:24 AM

You can submit time with the command. Example:

@holdex pr submit-time 15m

See available commands to help comply with our Guidelines.

@zolotokrylin
Copy link
Copy Markdown
Member Author

@holdex pr submit-time 1h

@zolotokrylin zolotokrylin merged commit 076b26d into main Apr 10, 2026
2 checks passed
@zolotokrylin zolotokrylin deleted the docs/problem-goal-sub-issue-linking branch April 10, 2026 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant