Skip to content

docs(contributing): add a "Before you open a pull request" section - #1559

Merged
chhoumann merged 1 commit into
masterfrom
chhoumann/contributing-before-you-pr
Jul 26, 2026
Merged

docs(contributing): add a "Before you open a pull request" section#1559
chhoumann merged 1 commit into
masterfrom
chhoumann/contributing-before-you-pr

Conversation

@chhoumann

@chhoumann chhoumann commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Adds contribution expectations after two purely AI-generated drive-by PRs (#1556, #1557) arrived on freshly-filed issues: contribute as a user of the plugin, claim the issue first, show human thought in AI-assisted work, and describe live verification. Folds the existing AI-assistance paragraph into the new section to avoid duplication.

Summary by CodeRabbit

  • Documentation
    • Added a “Before you open a pull request” checklist covering contribution expectations, issue claiming, and acceptable AI assistance.
    • Clarified the requirement for human review of AI-assisted contributions.
    • Added verification guidance for testing in a real Obsidian vault, including commands, version details, and screenshots.

Sets expectations for external PRs: contribute as a user of the plugin,
claim issues before writing code, purely AI-generated submissions with no
human interaction are likely to be closed, and describe live verification.
Folds the previous AI-assistance paragraph into the new section.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 26, 2026

Copy link
Copy Markdown

Deploying quickadd with  Cloudflare Pages  Cloudflare Pages

Latest commit: c6703ff
Status: ✅  Deploy successful!
Preview URL: https://73bf5ac1.quickadd.pages.dev
Branch Preview URL: https://chhoumann-contributing-befor.quickadd.pages.dev

View logs

@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated CONTRIBUTING.md with a “Before you open a pull request” checklist covering contribution expectations, issue claiming, AI assistance, human review, and real Obsidian vault verification.

Changes

Contribution guidance

Layer / File(s) Summary
Pull request preparation checklist
CONTRIBUTING.md
Replaces prior AI-assisted contribution guidance with checklist items for contributor history, issue claiming, acceptable AI use, self-review, and verification details including commands, versions, and screenshots.

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

Poem

A rabbit checks each box with care,
“Human eyes and tests go there!”
Vaults are opened, screenshots shine,
Clear contribution paths align.
Hop, submit—the checklist’s fine!

🚥 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 matches the main change: adding a new section to CONTRIBUTING.md.
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
  • Commit unit tests in branch chhoumann/contributing-before-you-pr

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 24-26: Update the verification checklist in CONTRIBUTING.md so
real Obsidian-vault verification is required only for plugin-runtime changes.
Add guidance to document bug-fix reproduction and regression tests, use
CLI-native seams for UI-only flows, and run pnpm run build-with-lint for
disruptive or generated-artifact changes.
🪄 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: 9d54ddd0-efa3-417b-a30d-d13544538e14

📥 Commits

Reviewing files that changed from the base of the PR and between 54c312f and c6703ff.

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

Comment thread CONTRIBUTING.md
@chhoumann
chhoumann merged commit 13e316b into master Jul 26, 2026
13 checks passed
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