Skip to content

[Docs]: Create a 'Contributing in 3 Minutes' illustrated quickstart guide in CONTRIBUTING.md #31

Closed

Description

@divyanshujethi

Documentation Area

CONTRIBUTING.md and GitHub Wiki

Current State / What is Missing

Our CONTRIBUTING.md currently explains git branch and pnpm commands, but lacks a concise quickstart table showing:

  • How JSON schemas work in shelf/*.json
  • How to test locally with pnpm run validate
  • How automated GitHub actions review PRs
  • How to request social shoutouts on LinkedIn/X

Suggested Improvement or New Content

Add a dedicated "3-Minute Fast Track" section with a visual flowchart or code block showing:

git clone https://github.com/RitualDev-Lab/DevShelf.git
cd DevShelf && pnpm install
# 1. Edit your chosen shelf file in shelf/
# 2. Test integrity
pnpm run validate
# 3. Build directory & README
pnpm run build

Can you submit a PR for this docs update?

Yes! I can write and submit the pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions