Contributing

Thank you for your interest in contributing! This documentation site thrives on community input, and there are many ways to help - no matter your skill level. (＾ω＾)

Work in progress

This contributing guide is a work in progress and may not answer all questions. If you have suggestions or need help, please open an issue or join the Discord community.

Ways to contribute

There are many ways you can help improve textmode.js and its documentation:

Submit an example sketch

Share your creative work! Example sketches help others learn and showcase what's possible with textmode.js.

Improve documentation

Help make the docs clearer and more helpful by fixing typos, improving explanations, or adding code examples.

If you want to suggest fonts or other textmode resources, contribute to awesome-textmode.

Report issues

Found something wrong? Open an issue describing:

• What you expected to happen
• What actually happened
• Steps to reproduce (if applicable)
• Screenshots (if helpful)

Getting started

Ready to contribute? Check out our Getting Started guide to set up your local development environment.

Credits

All contributors are recognized on the Contributors page and in the README using the All Contributors specification.

Maintainers update contributor recognition with npm run contributors:add -- <github-username> <contribution[,contribution]> and npm run contributors:generate. If you want extra social links on the website, add them to .vitepress/data/contributors.json.

Questions?

• Open an issue
• Join the Discord community

Thank you for helping to make the textmode.js documentation better!