👥 Contributing to Devex

📖 Before You Start

• •Carefully read the README.md at the root to understand what Devex is and how it works.
• •Explore the README.md files inside each subdirectory (core/, runner/, templates/, web/, etc.) to get a deeper understanding of each module.
• •Use PULL_REQUEST_TEMPLATE.md for creating a Pull Request.

🔧 Local Setup

You’ll need:

• •Docker & Docker Compose
• •Node.js (v20+)
• •Go (1.21+)

1. •Fork the repository to your GitHub account.
2. •Clone your fork:

bash
git clone https://github.com/your-username/devex.git
cd devex

1. •Create a new branch:

bash
git checkout -b feat/your-feature-name

• •feat/add-node-template
• •fix/typo-in-core
• •docs/update-template-guide

🚀 How to Contribute

1. 💡 Add a New Template

• •
  Add files to templates/<your-template>/
• •
  Add Dockerfile to runner/<your-template>.dockerfile
• •
  Register the template in:
  • •web/lib/templates.tsx
  • •core/models/templates.go

2. 🐛 Fix a Bug or Improve Code

• •Navigate to the relevant module (core/, runner/, web/, etc.).
• •Each has its own README.md and may contain TODOs, architecture notes, or issues.
• •Submit your fix as a PR with a descriptive title and message. Checkout PULL_REQUEST_TEMPLATE.md

3. 📝 Improve Docs

• •You can improve the documentation anywhere — main README.md, internal docs, or this CONTRIBUTING.md.
• •All text contributions are equally valuable!

🧪 Before Submitting a PR

• • Rebase from main to stay up to date.
• • Run and test your code locally.
• • Ensure templates are under 8MB (checked in CI).
• • Lint your code (if applicable).
• • Add/Update README if your change affects usage.
• • Avoid committing secrets or sensitive info.

📬 Submitting a Pull Request

bash
git add .
git commit -m "feat: add node.js template"
git push origin feat/add-node-template

1. •
   Open your GitHub fork
2. •
   Click “Compare & Pull Request”
3. •
   Fill out:
   • •What you changed
   • •Why it matters
   • •Anything reviewers should check/test
4. •
   Submit!

✅ PR Review & Merge

• •A maintainer (Parth) will review your PR.
• •You may get feedback — please respond or update the code as needed.
• •Once approved, it will be merged into main and deployed automatically (CI/CD pipelines are in place).

🔐 Required Secrets (for Maintainers)

Maintainers must configure these in GitHub → Repo Settings → Secrets > Actions

💬 Need Help?

• •Open a GitHub Issue
• •Or contact Parth Kapoor for guidance.