Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (45 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

61 lines (45 loc) · 1.95 KB

Contributing to [Project Name]

We’re excited you’re interested in contributing to [Project Name]! This guide covers installation, local development, and how to contribute.

Installation

Prerequisites

  • Language-specific prereqs (install node/go)
  • (usually include git/bash installation)

Installation

fill this with install step

Development Setup

Install dependencies:

fill this with install step

Run the linter:

fill this with linter step

Build the CLI:

fill this with build step

Contributing Guidelines

  • Create a feature branch from main (e.g., feat/add-postgres-stack).
  • Use Conventional Commits (feat:, fix:, chore:) to keep history clean and readable.
  • Include tests where applicable.
  • Run linting and tests before submitting a pull request.
  • Ensure your changes follow the existing project structure and registry-based stack system.

Issue Labels

When opening issues or reviewing pull requests, please apply the most relevant label(s) to help maintainers triage and prioritize them. Here’s a basic guide:

Label When to Use
bug A reproducible error, crash, or incorrect behavior in Taco.
feature A new capability or enhancement that does not exist yet.
enhancement Improvements to existing features, performance, or developer experience.
docs Documentation updates, typos, or README/CONTRIBUTING changes.
refactor Code cleanup or restructuring without changing behavior.
ci Issues related to GitHub Actions, testing, or build pipelines.
good first issue Small, well-scoped issues suitable for new contributors.

Tips:

  • Most issues should have one primary label.
  • If an issue touches multiple areas (e.g., a feature that also needs docs), feel free to add more than one.
  • PRs should ideally match the label of the issue they close.