Skip to content

chore: adding new docs#73

Merged
Prashant-Surya merged 2 commits intocanaryfrom
feat-update-docs
Feb 25, 2026
Merged

chore: adding new docs#73
Prashant-Surya merged 2 commits intocanaryfrom
feat-update-docs

Conversation

@sriramveeraghanta
Copy link
Copy Markdown
Member

@sriramveeraghanta sriramveeraghanta commented Feb 25, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added Claude Code guidance detailing repository interaction patterns, architecture overview, and environment setup
    • Added Code of Conduct establishing community standards, unacceptable behaviors, and enforcement guidelines
    • Added comprehensive Contribution guidelines covering project setup, coding standards, testing requirements, and tool submission procedures
    • Added Security policy outlining vulnerability reporting channels and responsible disclosure practices

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 25, 2026

📝 Walkthrough

Walkthrough

This PR adds four new documentation files to establish project governance and contribution guidelines: CLAUDE.md (AI interaction guidance), CODE_OF_CONDUCT.md (community standards), CONTRIBUTING.md (contribution process), and SECURITY.md (security policy). No functional code changes are introduced.

Changes

Cohort / File(s) Summary
Documentation & Community Guidelines
CLAUDE.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md
Adds four new documentation files establishing project governance, contribution guidelines, community standards, security policy, and AI interaction guidance for the Plane MCP Server repository.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 Four scrolls unfurled with care,
Rules and guidelines laid out fair,
Contributing paths now crystal clear,
Security promises and code of cheer,
Our community growing—hopping near! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic, using 'adding new docs' without specifying which documents or their purpose in the changeset. Consider a more specific title that identifies the key documentation being added, such as 'chore: add security and contribution guidelines' or 'docs: add CLAUDE, CODE_OF_CONDUCT, CONTRIBUTING, and SECURITY documentation'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat-update-docs

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

@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

♻️ Duplicate comments (1)
CLAUDE.md (1)

28-28: ⚠️ Potential issue | 🟡 Minor

Fragile xargs command for loading env vars — same as CONTRIBUTING.md line 77.

See the comment on CONTRIBUTING.md for the fix suggestion.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 28, The line with the fragile command "export $(cat
.env.test.local | xargs) && pytest tests/ -v" should be replaced with a robust
env-loading sequence: enable automatic export, source the .env.test.local file
only if it exists while ignoring comments/blank lines, then disable automatic
export and run pytest; in other words, stop using the xargs export pattern and
use a safe "set -a; source .env.test.local; set +a" (or a dotenv CLI) approach
so environment variables are loaded reliably and safely before invoking pytest.
🧹 Nitpick comments (1)
CODE_OF_CONDUCT.md (1)

117-119: Consider upgrading to Contributor Covenant v3.0.

Contributor Covenant 3.0 was released on July 28, 2025, making v2.0 two major versions behind. Version 3.0 is designed to be more adaptable to different kinds of communities and is written with clearer, less US-centric language intended to be easier to understand and translate. The updated version is available at https://contributor-covenant.org/.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CODE_OF_CONDUCT.md` around lines 117 - 119, Update the Code of Conduct header
text that currently states "version 2.0" to reference Contributor Covenant v3.0
and replace the old URL with the new canonical URL
(https://contributor-covenant.org/); specifically modify the line "This Code of
Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html." to
indicate v3.0 and point to the new site while preserving the attribution
formatting.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 88: Replace the phrase "unit-tests" with "integration tests" in the
CONTRIBUTING.md guideline line so it accurately reflects the project's test
suite; mention that tests are in tests/test_integration.py and run against a
live Plane instance (as described in CLAUDE.md) so contributors know which test
type to add and where to add them.
- Line 77: The current instruction `export $(cat .env.test.local | xargs)` is
unsafe for values with spaces/special chars; replace it with a robust approach
that sources the file with export enabled: use `set -a` then `source
.env.test.local` then `set +a` (or recommend using a dotenv parser) so
multi-word and quoted values are preserved; update the same pattern found in
CLAUDE.md line 28 as well and ensure the docs show the three-step `set
-a`/`source`/`set +a` sequence as the recommended command sequence.

---

Duplicate comments:
In `@CLAUDE.md`:
- Line 28: The line with the fragile command "export $(cat .env.test.local |
xargs) && pytest tests/ -v" should be replaced with a robust env-loading
sequence: enable automatic export, source the .env.test.local file only if it
exists while ignoring comments/blank lines, then disable automatic export and
run pytest; in other words, stop using the xargs export pattern and use a safe
"set -a; source .env.test.local; set +a" (or a dotenv CLI) approach so
environment variables are loaded reliably and safely before invoking pytest.

---

Nitpick comments:
In `@CODE_OF_CONDUCT.md`:
- Around line 117-119: Update the Code of Conduct header text that currently
states "version 2.0" to reference Contributor Covenant v3.0 and replace the old
URL with the new canonical URL (https://contributor-covenant.org/); specifically
modify the line "This Code of Conduct is adapted from the [Contributor
Covenant][homepage], version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html." to
indicate v3.0 and point to the new site while preserving the attribution
formatting.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 561a742 and f8c4d94.

📒 Files selected for processing (4)
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • SECURITY.md

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
@Prashant-Surya Prashant-Surya merged commit fe77c22 into canary Feb 25, 2026
1 check 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.

2 participants