Contributing

Contributing

Thank you for contributing to MomShell!

Getting Started

• Getting Started — Prerequisites and setup
• Development — Development workflow and commands

Code Quality

Before committing, run checks locally:

make check    # lint + typecheck (Go + Vue)
make format   # go fmt

Pre-commit hooks run automatically if installed:

pre-commit install

What the hooks check

• Go: gofmt, go vet, go build
• Vue: ESLint, vue-tsc
• General: trailing whitespace, YAML validity, merge conflicts, large files

Code Standards

Backend (Go):

• gofmt formatting
• go vet passes
• Follow standard Go project layout

Frontend (Vue/TypeScript):

• ESLint with eslint-plugin-vue + typescript-eslint
• vue-tsc type checking passes

Dependency Management

Backend:

cd backend
go get github.com/some/package
go mod tidy

Frontend:

cd frontend
npm install some-package

Lock files (go.sum, package-lock.json) must be committed.

Commit Convention

All commits follow Conventional Commits: type: description

Type	Description
feat	New feature
fix	Bug fix
refactor	Code restructuring
chore	Build, config, tooling
docs	Documentation
ci	CI/CD changes
test	Tests

Branch & PR Workflow

1. Create feature branch from main: feat/feature-name or fix/issue-name
2. Make changes, commit with conventional messages
3. Push and create PR targeting main
4. Ensure CI passes and request review

Sensitive Files

Never commit: .env, *.pem, *.key, credentials.json

Troubleshooting

Pre-commit hook failing? Run make check to see which check fails, fix, then commit again.

Frontend build failing? Delete node_modules and run npm install.

Port already in use?

lsof -i :8000
kill -9 <PID>

---

Home | GitHub