Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (23 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.62 KB
Raw

Contributing to textmode.js

Thank you for helping improve the textmode.js ecosystem.

You can contribute by improving existing example sketches in the public examples folder, updating the documentation, or contributing to add-on libraries such as textmode.synth.js, textmode.filters.js, textmode.figlet.js, and textmode.export.js.

Start with the shared code contribution guide for repository routing, setup, workflow, documentation, testing, asset, and review expectations.

Quick start

npm ci
npm run check

Create a focused branch from dev and open the pull request against dev. Discuss features, public API changes, architecture, rendering, packaging, browser support, or bundled assets in an issue or Discussion before implementation.

Add or update tests, API documentation, and examples when behavior changes. Test rendering changes in a real browser and include screenshots or recordings for visual changes.

Read the Code of Conduct. Report vulnerabilities privately by following SECURITY.md, not through a public issue.

Need help? Open an issue, start a Discussion.