Help: Contribution
Contribute safely by aligning changes with docs, tests, and release quality gates. Contributions should improve maintainability and user experience.
Prerequisites
- - A scoped issue or proposal tied to real user impact.
- - Local environment able to run tests and storefront build.
- - Understanding of existing interaction and accessibility contracts.
Step 1: Align work with an issue
Start from an existing issue or create one before coding to keep intent explicit.
Issue tracker:
https://github.com/jortega0033/diwa-components/issuesStep 2: Run quality checks locally
Validate tests and storefront build before opening a pull request.
npm test
npm run build:storefrontStep 3: Open a focused pull request
Use a concise summary, testing notes, and screenshots or recordings for UI changes.
Open PR:
https://github.com/jortega0033/diwa-components/compareImplementation Notes
- - Keep PRs scoped; separate unrelated refactors from feature/fix work.
- - Update docs routes when behavior or workflow changes.
- - Call out any a11y, motion, or responsive implications in PR descriptions.
Troubleshooting
- - If review feedback repeats, add shared guidance to relevant docs pages.
- - If tests fail in CI only, compare environment and browser assumptions.
- - If merge conflicts are frequent, reduce branch lifetime and scope.