Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (57 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 1.77 KB

Contributing to DevWizard

Thanks for investing your time in DevWizard. This guide helps you contribute quickly and consistently.

Ways to Contribute

  • Report bugs
  • Propose features
  • Improve docs and examples
  • Submit code fixes and enhancements
  • Add tests for edge cases

Before You Start

  1. Read README.md
  2. Check existing issues and pull requests
  3. Open an issue for significant changes before coding

Development Setup

1) Fork and clone

git clone https://github.com/DhruvP2205/DevWizard.git
cd DevWizard
git remote add upstream https://github.com/DhruvP2205/DevWizard.git

2) Install dependencies

npm install
cd frontend && npm install && cd ..
cd backend && go mod tidy && cd ..

3) Build

cd frontend && npm run build && cd ..
cd backend && go build -o ..\devwizard.exe ./cmd/cli && cd ..

Branching and Commits

  • Create a branch from main
  • Use small, focused commits
  • Recommended commit style:
    • feat(scope): add xyz
    • fix(scope): resolve xyz
    • docs(scope): improve xyz

Pull Request Checklist

  • Linked issue (if applicable)
  • Build passes locally
  • Tests updated/added where appropriate
  • Documentation updated
  • No unrelated refactors or formatting churn

Code Quality Expectations

  • Prefer deterministic behavior over implicit logic
  • Keep changes minimal and targeted
  • Follow existing style and project structure
  • Add or update tests when behavior changes

Reporting Bugs

When opening a bug, include:

  • OS and environment details
  • Exact command executed
  • Full error output
  • Steps to reproduce
  • Expected behavior vs actual behavior

Review Process

Maintainers may request changes before merge. Please keep discussion technical, concise, and collaborative.