Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (50 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

65 lines (50 loc) · 1.72 KB

Contributing to AgentStack

Thanks for helping build the best API catalog for AI agent builders.

Ways to Contribute

🆕 Add a New API

  1. Fork this repo and clone it locally
  2. Open lib/api-database.json
  3. Find the right category (or subcategory) for your API
  4. Add an entry following this format:
{
  "n": "API Name",
  "u": "https://docs.example.com",
  "d": "What this API does in plain English. Under 140 characters.",
  "f": true
}

Rules for descriptions:

  • Write like you're explaining it to a smart 15-year-old
  • No jargon (say "turns speech into text" not "ASR with diarization")
  • Under 140 characters
  • Start with what it does, not what it is

Rules for the f (free) field:

  • true if there's any free tier, free trial, or it's open source
  • false if it's purely paid with no free option
  1. Open a PR with the title: Add: [API Name]

✏️ Fix a Description

Same process as above. Find the entry, improve it, open a PR.

🪦 Report a Dead API

Open an issue titled Dead: [API Name] with:

  • The API name
  • What's wrong (URL 404, service discontinued, etc.)

💡 Suggest a New Category

Open an issue titled Category: [Proposed Name] with:

  • Why the existing categories don't cover it
  • At least 3 APIs that would belong in it

Development Setup

git clone https://github.com/stackwyre/agentstack.git
cd agentstack
npm install
npm run dev

The site runs at localhost:3000. The builder is at /builder.

Code Style

  • We use Next.js App Router
  • Styling is inline styles + Tailwind utilities
  • No external state management — React hooks only
  • Keep it simple. This project's power is in the data, not the framework.

Questions?

Open an issue. We're friendly.