Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (44 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

62 lines (44 loc) · 1.38 KB

Contributing to StackAtlas

Thanks for helping improve StackAtlas.

Contribution types

  • Add a new stack
  • Improve an existing stack
  • Replace an outdated tool
  • Add caveats or regional notes
  • Fix formatting, links, or wording

Ground rules

  • Keep entries practical and concise
  • Use direct product links only
  • No referral or affiliate links
  • Do not submit duplicate stacks with tiny variations
  • Prefer proven combinations over speculative ones

New stack checklist

Before opening a pull request, make sure your stack includes:

  • A clear project goal
  • 2 to 6 tools
  • A short reason the combo works well
  • At least one caveat or tradeoff
  • A difficulty level: Beginner, Intermediate, or Advanced

Entry template

Use this format:

## Stack Name

**Use case:** Short sentence
**Tools:** Tool A, Tool B, Tool C
**Difficulty:** Beginner | Intermediate | Advanced

**Why this combo works**
- Short point
- Short point

**Caveats**
- Short point
- Short point

Pull request tips

  • Keep one stack per pull request when possible
  • If you are changing an existing stack, explain what became outdated
  • If a tool has regional limits or signup restrictions, mention that clearly

Good first contributions

  • Add one missing stack from the README wanted list
  • Improve caveats on an existing entry
  • Standardize formatting in one data file
  • Add a better beginner-friendly stack