Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (61 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

87 lines (61 loc) · 1.81 KB
Raw

Contributing to SPAR Kit

Thank you for your interest in improving SPAR Kit! 🥊

Quick Start for Contributors

git clone https://github.com/synthanai/spar-kit.git
cd spar-kit
# Open index.html in your browser
# Make changes, refresh to test

No build step required, it's just HTML, CSS, and JavaScript.

Ways to Contribute

🎨 UI/UX Improvements

  • Dark/light mode toggle
  • Better mobile responsiveness
  • Accessibility improvements (ARIA, keyboard navigation)
  • Animation polish

🔌 New Integrations

  • Additional AI providers (Mistral, Cohere, local models)
  • Export formats (PDF, JSON)
  • Browser extension
  • Obsidian/Notion integration

🌍 Translations

  • Translate UI strings
  • Add RTL support
  • Localize persona prompts

🐛 Bug Fixes

  • Cross-browser compatibility
  • Error handling improvements
  • Edge cases in API responses

Code Style

  • Vanilla JavaScript - no frameworks, no build step
  • CSS custom properties - use existing --var tokens
  • Semantic HTML - proper ARIA labels, meaningful IDs
  • Comments - explain why, not what

Pull Request Process

  1. Fork the repo
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Test in multiple browsers (Chrome, Firefox, Safari)
  5. Submit PR with clear description

Commit Messages

Use emoji prefixes:

Emoji Type
✨ New feature
🐛 Bug fix
🎨 UI/styling
🔌 Integration
📝 Documentation
♿ Accessibility

Example: ✨ Add Mistral API integration

Questions?

Open an issue or reach out on LinkedIn.

நாலு பேரு, நாலு திசை, ஒரு முடிவு. Four Perspectives, Four Dimensions, One Synthesis.