Skip to content

Contributor Guide and Workflows

divyanshujethi edited this page Oct 13, 2026 · 1 revision

🀝 Contributor Guide & Development Workflow

We welcome submissions of developer tools, free APIs, AI agents, testing utilities, boilerplates, and startup perks!


πŸ’‘ Method 1: Submitting via GitHub Issues (No Git Required)

The quickest way to recommend a resource is to open an interactive issue template on GitHub:

Maintainers review incoming issues, verify endpoints, and merge them into the repository.


πŸ› οΈ Method 2: Submitting via Pull Request

If you prefer submitting directly via Git:

1. Fork and Clone

git clone https://github.com/<your-username>/DevShelf.git
cd DevShelf
pnpm install

2. Add Your Entry to shelf/

Choose the matching file:

  • shelf/apis.json β€” Free public APIs
  • shelf/cli-tools.json β€” Terminal and developer productivity utilities
  • shelf/ai-tools.json β€” Open-source AI tools and local LLM runners
  • shelf/testing-qa.json β€” Testing and QA frameworks
  • shelf/free-cloud.json β€” Permanent free tiers
  • shelf/contributors-wanted.json β€” Projects with open issues
  • shelf/perks.json β€” Maintainer/student sponsorships
  • shelf/boilerplates.json β€” 1-click deploy templates

3. Run Validation and Formatting

Before opening a PR, ensure all automated verification scripts succeed:

# 1. Validate data schema
pnpm run validate

# 2. Audit URLs and deduplicate
node scripts/validate-links.js

# 3. Format code with Biome
pnpm run format:check

# 4. Rebuild README, docs, and web app data
pnpm run build

4. Submit Your Pull Request

git checkout -b add-tool-name
git commit -m "feat(shelf): add ToolName to cli-tools.json"
git push origin add-tool-name

Open a Pull Request against main. Our CI will automatically verify your changes.


πŸŽ–οΈ Display the "Featured on DevShelf" Badge

If your project is curated on DevShelf, show it off on your README! Pick whichever style fits your project aesthetic:

Option 1: Modern Purple (Recommended)

Featured on DevShelf

[![Featured on DevShelf](https://img.shields.io/badge/Featured%20on-DevShelf-7928CA?style=for-the-badge&logo=googlechrome&logoColor=white)](https://devshelf.ritualdev.in/)

Option 2: Cyberpunk Neon Cyan

Featured on DevShelf

[![Featured on DevShelf](https://img.shields.io/badge/DevShelf-Curated%20Resource-00E5FF?style=for-the-badge&logo=github&logoColor=black)](https://devshelf.ritualdev.in/)

Option 3: Minimal Flat Square

Featured on DevShelf

[![Featured on DevShelf](https://img.shields.io/badge/Featured%20on-DevShelf-blueviolet?style=flat-square&logo=googlechrome&logoColor=white)](https://devshelf.ritualdev.in/)