🤝 Contributing to VulcanoConnects

Thank you for your interest in contributing to VulcanoConnects! This guide will help you get started.

📋 Ways to Contribute

🎨 Design Contributions

• Theme Improvements: Suggest color palette refinements
• UI/UX Feedback: Share insights on user experience
• Accessibility: Help ensure WCAG 2.1 AA compliance
• Design Assets: Provide icons, illustrations, or graphics

📝 Documentation

• Improve Existing Docs: Fix typos, clarify explanations
• Add Examples: Provide code samples and use cases
• Translations: Help translate documentation
• Tutorials: Create guides for specific features

🐛 Bug Reports

When reporting bugs, please include:

• Clear description of the issue
• Steps to reproduce
• Expected vs actual behavior
• Screenshots if applicable
• Browser/OS information

💡 Feature Requests

• Describe the problem you’re trying to solve
• Explain your proposed solution
• Discuss alternative approaches you considered
• Consider backward compatibility

🎨 Theme Contributions

For Designers

1. Review Current Theme
   • Check designer-schema.md
   • Understand existing token structure
   • Test in both light and dark modes
2. Propose Changes
   • Open an issue describing the change
   • Provide mockups or examples
   • Specify both light and dark mode values
   • Ensure accessibility (proper contrast ratios)
3. Design Handoff
   • Use semantic token names
   • Provide hex values for colors
   • Specify exact spacing/typography values
   • Document usage guidelines

For Developers

1. Using Theme Tokens
   • Always use theme classes (e.g., bg-primary, text-foreground)
   • Never hardcode colors or spacing
   • Test both light and dark modes
   • Follow patterns in developer-guide.md
2. Adding New Components
   • Use existing theme tokens when possible
   • If new tokens needed, propose them via issue first
   • Update documentation with usage examples
   • Ensure accessibility

✅ Contribution Guidelines

Documentation Standards

• Use clear, concise language
• Include code examples where helpful
• Keep file organization consistent
• Update table of contents when adding sections

Design Standards

• Maintain visual consistency
• Follow accessibility guidelines (WCAG 2.1 AA)
• Test in multiple browsers
• Consider mobile/responsive design

Communication

• Be respectful and inclusive
• Provide constructive feedback
• Ask questions when unclear
• Credit others’ contributions

📞 Getting Help

• Documentation Questions: Open an issue with the documentation label
• Design Questions: Open an issue with the design label
• General Questions: Open a discussion

🙏 Thank You

Every contribution, no matter how small, helps make VulcanoConnects better for everyone. We appreciate your time and effort!