Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 1.78 KB
Raw

Contributing to ToolKnit

First off, thank you for considering contributing to ToolKnit! 🎉

Ways to Contribute

🛠️ Submit a Standalone Tool Demo

We welcome standalone versions of ToolKnit tools that can run independently:

  1. Fork this repository
  2. Create a new directory under open-source/ (e.g., open-source/your-tool-standalone/)
  3. Include a self-contained index.html with all necessary JS/CSS inline or CDN-linked
  4. Add a brief README.md inside your tool directory explaining what it does
  5. Submit a Pull Request

Requirements for standalone demos:

  • Must run by opening index.html in a browser (no build step required)
  • Must be fully client-side (no server uploads)
  • Must use only browser APIs (Canvas, Web Audio, WebAssembly, etc.)
  • Should be a simplified version of an existing ToolKnit tool

📝 Improve Documentation

  • Fix typos or unclear explanations in README.md
  • Add usage guides or tutorials
  • Improve code comments in standalone demos

🐛 Report Issues

  • Use GitHub Issues to report bugs
  • Include: browser version, OS, steps to reproduce, expected vs actual behavior

🌐 Add Translations

  • ToolKnit supports English and 中文 (Chinese)
  • If you'd like to add another language, open an issue to discuss first

Pull Request Process

  1. Fork the repo and create your branch from main
  2. Make your changes with clear, descriptive commit messages
  3. Test your changes locally
  4. Submit a Pull Request with a clear description of what you've changed

Code Style

  • Vanilla JavaScript (no frameworks)
  • 2-space indentation
  • Descriptive variable names
  • Comments for complex logic

Questions?

Feel free to open an issue or visit toolknit.com for more information.