Skip to content

Comments

docs: add CONTRIBUTING.md and refresh README header#400

Open
picsoung wants to merge 2 commits intoopenclaw:mainfrom
picsoung:docs/contributing-and-readme-refresh
Open

docs: add CONTRIBUTING.md and refresh README header#400
picsoung wants to merge 2 commits intoopenclaw:mainfrom
picsoung:docs/contributing-and-readme-refresh

Conversation

@picsoung
Copy link

@picsoung picsoung commented Feb 18, 2026

I was trying to contribute and had issues finding out how to run the project locally.
Inspired by the OpenClaw's CONTRIBUTING.md and the README, decided to improve the ones here.

Summary

  • Add CONTRIBUTING.md with local Convex setup instructions — previously
    undocumented steps (env vars, GitHub OAuth, JWT keys, database seeding)
    were only discovered through trial and error
  • Refresh the README header with the centered lobster logo, badges, and a
    quick links row linking to live sites, docs, and the new contributing guide
  • Condense the README "Local dev" section and link to CONTRIBUTING.md for
    full details
  • Convert plain-text docs/ references to clickable markdown links

Test plan

  • Verify the logo renders correctly on GitHub (centered, 120px)
  • Confirm all quick links row URLs resolve
  • Confirm all docs/ links in the README point to existing files
  • Read through CONTRIBUTING.md for accuracy (env values, commands, callback URL)
  • Run bun run lint and bun run build to confirm no regressions

Questions

I could not find a dedicated ClawHub channel on Discord to reference in the doc.

AI disclosure

This PR was authored with Claude Code. All content was reviewed and
validated against the actual codebase (env var references, doc paths,
seed commands). The contributor (me 👋) understands and can maintain these files.

🤖 Generated with Claude Code

Greptile Summary

Adds a new CONTRIBUTING.md with detailed local development setup instructions (env vars, GitHub OAuth, JWT keys, database seeding, CLI testing) and refreshes the README.md header with a centered logo, badge row, and quick links. The README's "Local dev" section is condensed and now links to CONTRIBUTING.md for full details. Plain-text doc references are converted to clickable markdown links.

  • All referenced file paths (docs/, packages/clawdhub/, public/clawd-logo.png, VISION.md) verified to exist
  • Seed function names (devSeed:seedNixSkills, devSeedExtra:seedExtraSkillsInternal) match the exported Convex functions
  • The #setup-help Discord channel referenced in CONTRIBUTING.md may not exist — the PR author noted they couldn't find a dedicated ClawHub Discord channel

Confidence Score: 4/5

  • Documentation-only PR with no code changes — safe to merge after verifying the Discord channel reference.
  • This is a docs-only PR (new CONTRIBUTING.md + README refresh) with no functional code changes. All referenced file paths, seed commands, and env vars were verified against the codebase. The one concern is a Discord channel name that may not exist, which could mislead new contributors but has no runtime impact.
  • CONTRIBUTING.md line 5 references a #setup-help Discord channel that may not exist.

Last reviewed commit: b39114c

(2/5) Greptile learns from your feedback when you react with thumbs up/down!

Context used:

  • Context from dashboard - AGENTS.md (source)

Add a comprehensive CONTRIBUTING.md covering local Convex setup,
env var configuration, GitHub OAuth, JWT keys, database seeding,
CLI development, PR guidelines, and AI-generated code policy.

Refresh the README with a centered logo, quick links row, and
clickable doc references. Condense the Local dev section to link
to CONTRIBUTING.md for full setup details.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link
Contributor

vercel bot commented Feb 18, 2026

@picsoung is attempting to deploy a commit to the Amantus Machina Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

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