Contributors
Welcome! Dev Templates is an open-source project and we appreciate contributions of all kinds.
Ways to Contribute
| Contribution | Description | Start here |
|---|---|---|
| Create a template | Add a new language or framework template | Creating a Template |
| Fix bugs | Fix template code, manifests, or CI/CD issues | Check GitHub Issues |
| Improve docs | Fix errors, add examples, clarify instructions | See README Structure |
| File issues | Report bugs or suggest new templates | Open an issue on GitHub |
Quick Start
# 1. Fork and clone the repository
git clone https://github.com/<your-username>/dev-templates.git
cd dev-templates
# 2. Create a feature branch
git checkout -b feature/my-new-template
# 3. Create your template (see guide below)
mkdir templates/my-new-template
# ... add TEMPLATE_INFO, app code, README, Dockerfile, manifests
# 4. Validate locally
bash scripts/validate-metadata.sh
bash scripts/validate-docs.sh
# 5. Test the Docusaurus build
bash scripts/generate-templates-json.sh
bash scripts/generate-docs-markdown.sh --force
npm run build --prefix website
# 6. Submit a pull request
git push origin feature/my-new-template
Guides
- Creating a Template — step-by-step guide for the most common contribution
- Template Metadata Reference — all TEMPLATE_INFO fields explained
- Naming Conventions — how to name files, folders, and IDs
- Scripts Reference — validation and generation scripts
- README Structure — standard sections for template READMEs