Title: docs: write docs/contributing/setup.md β contributor workflow from fork to PR including test account creation with DEV ONLY role selector
Issue Summary
The contributor onboarding guide. Documents the full workflow from forking to submitting a PR: branch naming conventions, how to get env files from the maintainer, the DEV ONLY role selector in the register form (and why it exists), database reset procedure, and useful commands. Must be accurate β contributors will follow it exactly.
Type of Issue
Branch strategy
β
docs/issue-N-contributor-setup β consolidation-pattern
Expected Behavior
docs/contributing/setup.md covering:
1. Fork, clone, checkout consolidation-pattern
2. pnpm install
3. Get env files from maintainer β which variables need maintainer-provided values
4. Backend bootstrap β cd infra/backend && bin/start safetrust hotel_industry
5. Test account creation β register with DEV ONLY role selector (amber box in register form)
6. Branch naming β feat/issue-N-description, fix/issue-N-description, docs/issue-N-description
7. PR checklist β target branch consolidation-pattern, CodeRabbit response required, issue linked
8. DB reset β docker compose down -v && bin/start safetrust hotel_industry
9. Useful commands β kill ports, open Hasura console, TypeScript check
Files to create
| File |
Approx lines |
docs/contributing/setup.md |
~130 |
Make sure to follow the Git Guidelines for Atomic Commits and read Contributing Guide
Issue L β dApp-SafeTrust
Title: docs: write docs/contributing/issue-template.md β 8-section issue anatomy, GrantFox A-rating criteria, and acceptance criteria checklist format
Issue Summary
Documents the mandatory 8-section issue template that every SafeTrust issue follows. Contributors who create issues (wave participants, maintainer) need this to write issues that pass the quality bar for GrantFox grading and CodeRabbit review. Includes a real example for each section and the GrantFox A-rating criteria table.
Type of Issue
Branch strategy
β
docs/issue-N-issue-template β consolidation-pattern
Expected Behavior
docs/contributing/issue-template.md covering:
1. All 8 sections β Issue Summary, Type of Issue, Branch Strategy, Current Behavior, Expected Behavior, Reproduction Steps, Environment Details, Supporting Information β with a "good vs bad" example for the most important section (Issue Summary)
2. GrantFox A-rating criteria table β all 6 criteria that must be present together
3. Issue title format β type(scope): description with valid types and examples
4. Acceptance criteria format β checkbox checklist at the end of every issue
5. What gets issues returned β missing sections, invented problems, single-file trivial changes
Files to create
| File |
Approx lines |
docs/contributing/issue-template.md |
~120 |
Make sure to follow the Git Guidelines for Atomic Commits and read Contributing Guide
Title:
docs: write docs/contributing/setup.md β contributor workflow from fork to PR including test account creation with DEV ONLY role selectorIssue Summary
The contributor onboarding guide. Documents the full workflow from forking to submitting a PR: branch naming conventions, how to get env files from the maintainer, the DEV ONLY role selector in the register form (and why it exists), database reset procedure, and useful commands. Must be accurate β contributors will follow it exactly.
Type of Issue
Branch strategy
Expected Behavior
docs/contributing/setup.mdcovering:1. Fork, clone, checkout
consolidation-pattern2.
pnpm install3. Get env files from maintainer β which variables need maintainer-provided values
4. Backend bootstrap β
cd infra/backend && bin/start safetrust hotel_industry5. Test account creation β register with DEV ONLY role selector (amber box in register form)
6. Branch naming β
feat/issue-N-description,fix/issue-N-description,docs/issue-N-description7. PR checklist β target branch
consolidation-pattern, CodeRabbit response required, issue linked8. DB reset β
docker compose down -v && bin/start safetrust hotel_industry9. Useful commands β kill ports, open Hasura console, TypeScript check
Files to create
docs/contributing/setup.mdMake sure to follow the Git Guidelines for Atomic Commits and read Contributing Guide
Issue L β
dApp-SafeTrustTitle:
docs: write docs/contributing/issue-template.md β 8-section issue anatomy, GrantFox A-rating criteria, and acceptance criteria checklist formatIssue Summary
Documents the mandatory 8-section issue template that every SafeTrust issue follows. Contributors who create issues (wave participants, maintainer) need this to write issues that pass the quality bar for GrantFox grading and CodeRabbit review. Includes a real example for each section and the GrantFox A-rating criteria table.
Type of Issue
Branch strategy
Expected Behavior
docs/contributing/issue-template.mdcovering:1. All 8 sections β Issue Summary, Type of Issue, Branch Strategy, Current Behavior, Expected Behavior, Reproduction Steps, Environment Details, Supporting Information β with a "good vs bad" example for the most important section (Issue Summary)
2. GrantFox A-rating criteria table β all 6 criteria that must be present together
3. Issue title format β
type(scope): descriptionwith valid types and examples4. Acceptance criteria format β checkbox checklist at the end of every issue
5. What gets issues returned β missing sections, invented problems, single-file trivial changes
Files to create
docs/contributing/issue-template.mdMake sure to follow the Git Guidelines for Atomic Commits and read Contributing Guide