Contributing to ProductBuildersHQ projects

Thank you for your interest in contributing!

Definition of Done

All PRs must satisfy the Definition of Done before merge. This includes passing tests, linting, documentation updates, RMI trailers, and changelog entries.

Getting Started

1. Fork the repository
2. Clone your fork locally
3. Create a feature branch
4. Make your changes
5. Run tests and linting
6. Submit a pull request

PRISM Control

ProductBuildersHQ repos are typically registered in prism-control. Before starting work:

prismctl work ready --repo <repo>     # Find claimable work
prismctl work claim <RMI-ID>          # Claim an RMI

Commits implementing roadmap items must carry the Refs: RMI-<ID> trailer.

Development Requirements

Go Projects

• Go 1.26 or later
• golangci-lint

TypeScript/Electron Projects

• Node.js 20.x or later
• npm

Code Style

Go

• Run gofmt for formatting
• Run golangci-lint run before committing
• Follow Effective Go guidelines

TypeScript

• Run npm run lint before committing
• Follow project ESLint configuration

Commit Messages

Follow Conventional Commits:

feat: add new feature
fix: resolve bug
docs: update documentation
test: add tests
refactor: restructure code
chore: maintenance tasks

Pull Request Process

1. Ensure tests pass
2. Ensure linting passes
3. Update documentation if needed
4. Add changelog entry if applicable
5. Include RMI trailer if implementing a roadmap item
6. Request review from maintainers

Questions?

Open an issue for questions or discussions.