# Contributing to Vibe-Coding Prompt Template

Thanks for your interest in improving the Vibe-Coding workflow! 🙌  
Pull requests and issue reports are welcome.

This repository focuses on a reusable workflow for taking an idea from research to shipped MVP, not on hosting a single application codebase.

## Before you start

- Read the README to understand the goals of this project and its scope.
- Review the Code of Conduct (CODE_OF_CONDUCT.md). By participating, you agree to follow it.

## How to propose changes

### Bug reports / issues

- Use GitHub Issues.
- Include:
  - What you were trying to do.
  - The exact section/file (e.g. `part2-prd-mvp.md`, `AGENTS.md`).
  - What went wrong or was unclear.
  - If relevant, which AI tool / IDE you used (Cursor, Claude Code, Gemini CLI, etc.).

### Suggesting improvements

Good candidates for contributions:

- Clarifying confusing wording in prompts or docs.
- Updating examples for newer AI tools or model versions.
- Adding missing steps or checks to the workflow.
- Sharing a live product or case study built with this workflow.
- Adding better onboarding notes for beginners using AI IDEs for the first time.
- Fixing typos, formatting, or broken links.

Out of scope (will usually be closed):

- Project-specific prompts tightly coupled to a single private stack.
- Vendor marketing or non-neutral comparisons.

Open an issue first for any **large** change so we can agree on direction.

## Community-friendly contributions

Useful non-code contributions are welcome too:

- Share what you built with the workflow and what parts helped or failed.
- Suggest clearer wording for first-time builders who are not yet comfortable with AI IDEs.
- Propose tool-specific guidance for Cursor, Claude Code, GitHub Copilot, Gemini CLI, or similar tools.
- Submit link fixes, screenshots, or example outputs that make the workflow easier to trust.

## Pull request guidelines

- Fork the repo and create a feature branch.
- Keep PRs focused and small where possible.
- Update any relevant docs (README, partX files, AGENTS.md comments, etc.).
- Add a short description explaining:
  - What changed.
  - Why it helps users of the workflow.
  - Any breaking changes to existing instructions.
- If your change adds a new example or showcase item, include the public URL and a one-line explanation of what was built.

Maintainers may ask for tweaks before merging.

## Validating changes

Before submitting a PR, run the repo's contract checks locally:

```bash
python scripts/validate.py
```

The script verifies the structural rules the templates rely on (required sections in `templates/AGENTS.md`, handoff blocks in the part files, skill frontmatter, config file validity, and more) and prints a PASS/FAIL line per rule. CI runs the same checks plus an external link check, so a green local run means a green build.

## Style and formatting

- Use clear, concise English.
- Prefer actionable, step-by-step instructions for contributors using AI tools.
- Follow the existing heading hierarchy and Markdown style in the repo.
- When mentioning tools (Claude, Gemini, Cursor, etc.), use their current names and link to their official docs when adding new references.

## Code of Conduct

This project follows the Contributor Covenant Code of Conduct (see `CODE_OF_CONDUCT.md`).  
Report unacceptable behavior to the contact address listed there.