Contributing

Start with an issue or design note when a change affects architecture, persistent data, authentication, or packaging

Workflow

1. Create a focused branch and preserve unrelated local changes
2. Implement the change in the subsystem that owns the behavior
3. Add a regression test when behavior changes
4. Update both documentation languages and any affected examples or screenshots
5. Run the relevant test suite
6. Validate documentation and license headers

From the repository root

python3 Scripts/license_headers.py --check
cd Docs
npm run check
PAGES_BASE_PATH=/HyPrism npm run build

Review checklist

• Describe the problem, resulting behavior, and relevant tradeoffs
• Keep Core, Desktop, and Local Node responsibilities clear
• Document public contracts and stored-data changes
• Include no credentials, personal data, generated builds, or caches
• Confirm both language trees describe the implementation
• Report checks performed and any unverified platform boundary

Use a docs: commit prefix when the commit changes documentation only. Follow the detailed writing and screenshot policy in AGENTS.md

Bug reports

Use GitHub issue templates. Include platform, launcher version, reproduction steps, expected and actual behavior, and relevant logs

Review attachments for credentials and personal paths before posting