Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (28 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.3 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to the Build in Public Knowledge Hub! Community contributions help keep these playbooks accurate, comprehensive, and valuable for builders worldwide.

🛠️ How You Can Contribute

  1. Submit New Modules & Playbooks: Propose new engineering, product, or growth guides relevant to building in public.
  2. Improve Existing Content: Fix typos, update outdated tool references, or add new real-world case studies.
  3. Enhance Visual Diagrams & Code Snippets: Add clear ASCII diagrams, flowcharts, or code examples.

📋 Pull Request (PR) Workflow

  1. Fork this repository.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/buildinpublic.git
  3. Create a topic branch: 
    git checkout -b docs/add-new-guide
  4. Commit your changes with clear, descriptive commit messages: 
    git commit -m "docs: add guide on indie SaaS pricing strategies"
  5. Push to your fork and submit a Pull Request to the main branch.

📐 Formatting Standards

  • Follow GitHub Flavored Markdown (GFM).
  • Keep tone objective, first-principles-based, and actionable.
  • Ensure all markdown links are valid and relative paths are formatted correctly.