Document edge cases for /run-skipped-ci workflow

[justin808]

Summary

• Documents edge cases for the /run-skipped-ci workflow in CONTRIBUTING.md
• Adds important notes about force-push and branch deletion behavior

Closes #2002

Test plan

• Documentation only change - no functional changes
• Verify markdown renders correctly in GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Updated contribution guidelines with additional notes on CI workflow behavior during development, including guidance on force-pushes and branch operations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

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

⌛ 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 26d5d1c and cb9339a.

📒 Files selected for processing (1)

• CONTRIBUTING.md (1 hunks)

Walkthrough

A documentation update to CONTRIBUTING.md that adds an "Important Notes" section describing edge cases for the /run-skipped-ci workflow. Two bullet points document behavior when force-pushing after triggering CI and warn against branch operations during workflow execution.

Changes

Cohort / File(s)	Summary
Documentation: CI edge cases CONTRIBUTING.md	Adds "Important Notes" section under CI run control instructions with guidance on force-push behavior and branch operations during workflow execution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Straightforward documentation addition with no code logic or behavioral changes
• Content mirrors the edge case documentation requirements from the linked issue
• No complex interactions or dependencies to verify

Suggested labels

review-needed

Poem

🐰 A note in the docs, oh what a delight,
About force-pushes and branches—do it right!
Let workflows complete before you push,
Or tests run on old code in a rush!
Documentation hops to the rescue so bright! ✨

Pre-merge checks and finishing touches

✅ 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 accurately and concisely summarizes the main change: documenting edge cases for the /run-skipped-ci workflow.
Linked Issues check	✅ Passed	The PR implementation fully addresses both edge cases from issue #2002: force-push behavior and branch deletion warnings are documented in CONTRIBUTING.md.
Out of Scope Changes check	✅ Passed	All changes are directly related to documenting edge cases for the /run-skipped-ci workflow; no out-of-scope modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Code Review ✅

This is a documentation-only PR that adds important clarifications to the /run-skipped-ci workflow usage. The changes are excellent and accurately describe the workflow behavior.

✅ Strengths

1. Accurate technical documentation: The notes correctly describe how the workflow behaves:

   • Line 83-84 in .github/workflows/run-skipped-ci.yml shows the workflow captures pr.data.head.sha at the time of comment
   • This confirms the "Force-pushes" note is technically accurate

2. Addresses real edge cases: Based on issue CI: Document edge cases for /run-skipped-ci workflow #2002, these are actual scenarios that could confuse users

3. Clear and concise: The warning messages are brief but informative

4. Good placement: The notes are positioned right after the /stop-run-skipped-ci section, making them easy to find

📝 Minor Suggestions (Optional)

While the current documentation is clear, consider these minor enhancements for even better clarity:

1. Add a practical example to make the edge case more concrete:

   - **Force-pushes:** The workflow runs against the commit SHA at the time of the comment. If you force-push after commenting, the workflow will test the old commit. 
     *Example: Comment on commit `abc123`, then force-push `def456` → CI tests `abc123`. Solution: Comment `/run-skipped-ci` again.*

2. Cross-reference the workflow behavior to help advanced users:

   - **Force-pushes:** The workflow runs against the commit SHA at the time of the comment (captured in `.github/workflows/run-skipped-ci.yml:83`). If you force-push after commenting, the workflow will test the old commit. Comment again to test the new commit.

However, these are truly optional - the current documentation is already clear and follows the project's style of being concise.

🎯 Conclusion

LGTM (Looks Good To Me) ✅

This PR:

• ✅ Is documentation-only (no functional changes)
• ✅ Accurately describes workflow behavior
• ✅ Addresses a real user confusion scenario
• ✅ Follows the project's documentation style
• ✅ Closes issue CI: Document edge cases for /run-skipped-ci workflow #2002

The markdown will render correctly in GitHub, and the changes align perfectly with the project's contributing guidelines.

---

Review performed by Claude Code