Contributing overview

​

Ways to contribute

• Report bugs - Found an issue? Let us know
• Request features - Have an idea for a new utility? We’d love to hear it
• Add utilities - Contribute new developer tools to the collection
• Fix bugs - Help resolve existing issues
• Improve documentation - Make our docs clearer and more helpful
• Enhance existing utilities - Add features or improve performance

​

Getting started

git clone https://github.com/your-username/try-devutils.git
cd trydevutils

npm install

npm run dev

git checkout -b feature/your-feature-name

npm run check  # Type check and build
npm run lint   # Check code style
npm run test   # Run Playwright tests

​

Reporting bugs

1. Check if the bug has already been reported in GitHub Issues
2. If not, create a new issue with a detailed description
3. Include:
   • Clear steps to reproduce the bug
   • Expected vs actual behavior
   • Browser, OS, and device information
   • Sample input that causes the issue
   • Any error messages from the browser console (F12 → Console)
   • Screenshots if relevant

​

Requesting features

1. Check existing feature requests
2. Create a new issue describing your feature idea
3. Include:
   • What problem the utility solves
   • How it would work
   • Why it would be valuable to developers
   • Any examples from other tools

​

Development workflow

​

Available commands

npm run dev              # Web dev server (port 8080)
npm run build            # Production web build
npm run test             # Run Playwright tests
npm run lint             # Run ESLint
npm run check            # Type check + build
npm run tauri:dev        # Desktop app dev (requires Rust)
npm run tauri:build      # Build desktop app
npm run extension:prepare # Build Chrome extension

​

Project structure

src/
  components/
    utils/              # Individual utility components
    ui/                 # Shared UI components
  lib/
    utils.ts            # Utility registration
    lazyUtils.ts        # Lazy-loaded components
src-tauri/              # Desktop app (Tauri)
extension/              # Chrome extension manifest
tests/                  # Playwright tests

​

Code review process

1. A maintainer will review your pull request
2. They may request changes or ask questions
3. Address any feedback by pushing additional commits
4. Once approved, a maintainer will merge your PR

​

Community guidelines

• Be respectful and constructive in discussions
• Follow the code of conduct
• Ask questions if you’re unsure about anything
• Help other contributors when you can

​

Next steps