Skip to main content

Contributing & Community

Welcome to the Lunarbit Studios community! We're excited to have you contribute to our open-source projects and help make them even better.

How to Contribute​

Getting Started​

  1. Choose a Project: Browse our projects and find one that interests you
  2. Fork the Repository: Create your own copy of the project on GitHub
  3. Set Up Development: Follow the project-specific setup instructions
  4. Find an Issue: Look for good first issues or create a new one
  5. Make Changes: Implement your feature or fix
  6. Submit a Pull Request: Share your contribution with the community

Contribution Guidelines​

Code Contributions​

  • Follow Existing Style: Maintain consistency with the project's coding style
  • Write Tests: Add tests for new features when applicable
  • Document Changes: Update documentation for any new features
  • Small Focused Changes: Keep pull requests focused and atomic
  • Descriptive Commits: Write clear, descriptive commit messages

Documentation Contributions​

  • Improve Guides: Help make our documentation clearer and more comprehensive
  • Add Examples: Contribute real-world usage examples
  • Fix Typos: Even small fixes are valuable contributions
  • Translate Content: Help make our projects accessible in multiple languages

Bug Reports​

  • Search First: Check if the issue already exists
  • Provide Details: Include steps to reproduce, expected behavior, and actual behavior
  • Include Environment: Share your OS, browser/Python version, and other relevant details
  • Use Templates: Follow our issue templates when available

Development Workflow​

# 1. Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/PROJECT_NAME.git
cd PROJECT_NAME

# 2. Create a feature branch
git checkout -b feature/your-feature-name

# 3. Make your changes
# ... code, test, commit ...

# 4. Push your branch
git push origin feature/your-feature-name

# 5. Open a pull request on GitHub

Areas Where We Need Help​

🏢 Trackly​

  • Mobile App Development: React Native or Flutter mobile applications
  • API Development: RESTful API for third-party integrations
  • Testing: Unit and integration tests for better reliability
  • UI/UX Improvements: Enhanced user interface and experience
  • Documentation: User guides and API documentation

🎮 Modrinth Auto-Updater​

  • CurseForge Integration: Support for CurseForge modpacks
  • GUI Enhancements: Improved user interface and experience
  • Performance Optimization: Faster processing for large modpacks
  • Testing: Automated testing with various modpack configurations
  • Documentation: Installation guides for different platforms

📊 CSViewer​

  • Chart Types: Additional visualization options (scatter plots, bar charts)
  • Data Export: Export functionality for processed data
  • Mobile Optimization: Enhanced mobile user experience
  • Accessibility: Better support for screen readers and accessibility tools
  • Internationalization: Multi-language support

🔧 WXR to CSV​

  • GUI Interface: User-friendly graphical interface
  • Output Formats: Support for JSON, XML, and database formats
  • Performance: Optimization for very large WordPress exports
  • Error Handling: Better error recovery and user feedback
  • Documentation: More comprehensive usage examples

Community Guidelines​

Code of Conduct​

We are committed to providing a welcoming and inclusive environment for everyone. All participants in our community are expected to:

  • Be Respectful: Treat all community members with respect and kindness
  • Be Inclusive: Welcome newcomers and help them feel at home
  • Be Collaborative: Work together constructively and professionally
  • Be Patient: Remember that everyone has different experience levels
  • Be Constructive: Provide helpful feedback and suggestions

Communication Channels​

GitHub​

  • Issues: Bug reports, feature requests, and general discussions
  • Pull Requests: Code contributions and reviews
  • Discussions: Community conversations and Q&A

Discord (Coming Soon)​

  • Real-time Chat: Quick questions and community interaction
  • Project Channels: Dedicated channels for each project
  • Help & Support: Get assistance from community members
  • Announcements: Stay updated on project news

Social Media​

  • Twitter/X: Follow us for project updates and tech insights
  • LinkedIn: Professional updates and company news
  • YouTube: Tutorial videos and project showcases

Recognition & Rewards​

Contributor Recognition​

  • Contributors Page: Your name on our contributors list
  • GitHub Profile: Contributions visible on your GitHub profile
  • Special Mentions: Recognition in release notes and announcements
  • Swag: Lunarbit Studios merchandise for significant contributors

Maintainer Opportunities​

Outstanding contributors may be invited to become project maintainers with additional responsibilities:

  • Code Review: Help review and merge pull requests
  • Issue Triage: Help organize and prioritize issues
  • Release Management: Assist with project releases
  • Community Management: Help guide community discussions

Project-Specific Contribution Info​

Trackly Development​

# Setup development environment
git clone https://github.com/LunarBit-dev/Trackly.git
cd Trackly
npm install

# Setup backend
cd backend
pip install -r requirements.txt
cd ..

# Start development
npm run dev

Key Technologies: React, TypeScript, Firebase, Python Flask
Getting Started: Check the Trackly documentation for detailed setup

Modrinth Auto-Updater Development​

# Setup development environment
git clone https://github.com/LunarBit-dev/Modrinth-Auto-Updater.git
cd Modrinth-Auto-Updater
pip install -r requirements.txt

# Run tests
python -m pytest tests/

# Start GUI development
python run_gui.py

Key Technologies: Python, Tkinter/GUI frameworks, Modrinth API
Getting Started: Check the Modrinth Auto-Updater documentation

CSViewer Development​

# Setup development environment
git clone https://github.com/LunarBit-dev/CSViewer.git
cd CSViewer
npm install

# Start development
npm run dev

# Run tests
npm test

Key Technologies: React, Vite, Recharts, TailwindCSS
Getting Started: Check the CSViewer documentation

WXR to CSV Converter Development​

# Setup development environment
git clone https://github.com/LunarBit-dev/WXR-to-CSV.git
cd WXR-to-CSV

# Run tests
python -m pytest tests/

# Test conversion
python wxr_to_csv.py sample_export.xml

Key Technologies: Python (standard library only)
Getting Started: Check the WXR to CSV documentation

First-Time Contributors​

Good First Issues​

We maintain "good first issue" labels on all our repositories to help newcomers find suitable contribution opportunities:

  • Documentation: Improve README files, add examples, fix typos
  • Bug Fixes: Small, well-defined bugs that are easy to fix
  • UI Improvements: Small visual enhancements and user experience improvements
  • Tests: Add tests for existing functionality
  • Examples: Create example projects or usage demonstrations

Getting Help​

Don't hesitate to ask for help! Our community is friendly and supportive:

  • Comment on Issues: Ask questions directly on GitHub issues
  • Join Discussions: Participate in GitHub Discussions
  • Contact Maintainers: Reach out to project maintainers for guidance

Release Process​

Version Numbering​

We follow Semantic Versioning:

  • MAJOR: Breaking changes
  • MINOR: New features (backward compatible)
  • PATCH: Bug fixes (backward compatible)

Release Cycle​

  • Regular Releases: We aim for regular releases with accumulated features and fixes
  • Hotfixes: Critical bug fixes are released as soon as possible
  • Beta Releases: Major features may be released as beta versions for testing

Changelog​

All projects maintain detailed changelogs documenting:

  • New features and enhancements
  • Bug fixes and improvements
  • Breaking changes
  • Deprecation notices

Community Events​

Hacktoberfest​

We participate in Hacktoberfest every October:

  • Special labels for Hacktoberfest issues
  • Beginner-friendly contribution opportunities
  • Recognition for participants

Community Calls (Planned)​

  • Monthly Meetings: Virtual meetings to discuss project roadmaps
  • Office Hours: Regular time slots for community Q&A
  • Workshops: Technical workshops and tutorials

Sponsorship & Support​

GitHub Sponsors​

Support our development through GitHub Sponsors:

  • Individual Sponsorship: Support individual developers
  • Organization Sponsorship: Corporate sponsorship opportunities
  • One-time Donations: Flexible contribution options

Corporate Partnerships​

We welcome partnerships with organizations that share our vision:

  • Open Source Sponsorship: Support for continued development
  • Feature Development: Sponsored development of specific features
  • Consulting Services: Custom development and integration services

Thank You​

We're grateful to all our contributors, users, and community members who make Lunarbit Studios projects possible. Your contributions, feedback, and support drive us to create better software for everyone.

Current Contributors​

A big thank you to all our contributors! You can see the full list of contributors for each project on their respective GitHub repositories.

Special Thanks​

  • Beta Testers: Users who help test new features and report issues
  • Documentation Writers: Contributors who improve our documentation
  • Community Moderators: Volunteers who help maintain our community spaces
  • Translators: Contributors who help make our projects accessible globally

Join us in building amazing software together! 🚀