docs: add CONTRIBUTING.md and refresh README header#400
Open
picsoung wants to merge 2 commits intoopenclaw:mainfrom
Open
docs: add CONTRIBUTING.md and refresh README header#400picsoung wants to merge 2 commits intoopenclaw:mainfrom
picsoung wants to merge 2 commits intoopenclaw:mainfrom
Conversation
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>
Contributor
|
@picsoung is attempting to deploy a commit to the Amantus Machina Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
CONTRIBUTING.mdwith local Convex setup instructions — previouslyundocumented steps (env vars, GitHub OAuth, JWT keys, database seeding)
were only discovered through trial and error
quick links row linking to live sites, docs, and the new contributing guide
CONTRIBUTING.mdforfull details
docs/references to clickable markdown linksTest plan
docs/links in the README point to existing filesCONTRIBUTING.mdfor accuracy (env values, commands, callback URL)bun run lintandbun run buildto confirm no regressionsQuestions
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.mdwith detailed local development setup instructions (env vars, GitHub OAuth, JWT keys, database seeding, CLI testing) and refreshes theREADME.mdheader with a centered logo, badge row, and quick links. The README's "Local dev" section is condensed and now links toCONTRIBUTING.mdfor full details. Plain-text doc references are converted to clickable markdown links.docs/,packages/clawdhub/,public/clawd-logo.png,VISION.md) verified to existdevSeed:seedNixSkills,devSeedExtra:seedExtraSkillsInternal) match the exported Convex functions#setup-helpDiscord channel referenced inCONTRIBUTING.mdmay not exist — the PR author noted they couldn't find a dedicated ClawHub Discord channelConfidence Score: 4/5
#setup-helpDiscord 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:
dashboard- AGENTS.md (source)