Skip to main content

Contributing to MUNify Tools

AI-Generated Content

This documentation page was initially generated by AI to bootstrap the documentation structure. Content may be incomplete or contain inaccuracies. We welcome contributions to improve it.

Thank you for your interest in contributing to MUNify utility tools!

Getting Started​

  1. Choose a tool to work on
  2. Fork the repository on GitHub
  3. Clone your fork locally
  4. Create a branch for your changes
  5. Submit a pull request

Contribution Guidelines​

Code Style​

Each tool may have different conventions:

  • Badge Generator: JavaScript best practices
  • Streamline: Go or Node.js conventions
  • Other tools: Check the repository README

Commit Messages​

Use clear commit messages:

feat(badge): add QR code support

- Generate QR codes from participant IDs
- Add QR code positioning options
- Update templates to include QR zones

Pull Requests​

When submitting:

  1. Describe your changes clearly
  2. Reference any related issues
  3. Include screenshots for UI changes
  4. Ensure tests pass

Tool-Specific Guides​

Badge Generator​

Focus areas:

  • New template designs
  • Export format support
  • Performance improvements
  • Accessibility features

Streamline​

Focus areas:

  • Service integrations
  • Sync reliability
  • Configuration options
  • Monitoring features

Testing​

Test your changes thoroughly:

  • Unit tests for logic
  • Integration tests for APIs
  • Manual testing for UI

Documentation​

Update documentation when:

  • Adding new features
  • Changing configuration
  • Modifying behavior

Community​

  • Be respectful
  • Help newcomers
  • Share knowledge
  • Celebrate contributions

License​

All MUNify tools are under AGPL-3.0 or similar open-source licenses. Check individual repositories for details.