How to Support the Platform
Thank you for your interest in contributing to LodgeBeacon! This project exists to support Masonic halls, and we welcome contributions from Freemasons and non-Masons alike who share our commitment to practical, respectful technology.
- Feature development
- Bug fixes
- Performance improvements
- Testing and quality assurance
- Writing guides and tutorials
- Improving README files
- Translating content
- Creating examples
- UI/UX improvements
- Brand assets
- Accessibility enhancements
- Template designs
- Testing with your lodge or hall
- Providing feature requests
- Reporting issues
- Sharing success stories
- Answering questions
- Helping other halls get started
- Sharing knowledge
- Promoting the platform
- Node.js 18+
- Python 3.10+ (for backend modules)
- Docker
- Git
Each module is a separate repository:
lodgebeacon-display/ # Digital signage
lodgebeacon-calendar/ # Booking and diary
lodgebeacon-continuity/ # Business continuity
lodgebeacon-web/ # Web presence
lodgebeacon-docs/ # Documentation
lodgebeacon-brand/ # Brand assets
lodgebeacon-ops/ # Infrastructure
- Fork the relevant repository
- Clone your fork
- Install dependencies (
npm installorpip install) - Set up environment variables (see
.env.example) - Run development server
- Make changes
- Submit pull request
- Follow existing code style
- Use provided linters (ESLint, Prettier, Black)
- Write clear, self-documenting code
- Comment complex logic
- Write tests for new features
- Maintain test coverage
- Test across browsers/devices
- Include integration tests where appropriate
Follow conventional commits:
type(scope): description
Types:
- feat: New feature
- fix: Bug fix
- docs: Documentation
- style: Formatting
- refactor: Code restructuring
- test: Testing
- chore: Maintenance
Examples:
feat(display): add emergency message override
fix(calendar): resolve booking conflict bug
docs(readme): update installation instructions
- Ensure tests pass
- Update documentation
- Add CHANGELOG entry
- Link related issues
## Description
Brief description of changes
## Type
- [ ] Feature
- [ ] Bug fix
- [ ] Documentation
- [ ] Refactoring
## Testing
How was this tested?
## Checklist
- [ ] Tests pass
- [ ] Documentation updated
- [ ] CHANGELOG updated
- [ ] No breaking changes (or documented)- Automated checks run
- Maintainer review
- Feedback addressed
- Approved and merged
We're seeking Masonic halls willing to test LodgeBeacon modules:
Benefits:
- Early access to features
- Direct input on development
- Priority support
- Recognition in documentation
Requirements:
- Active Masonic hall
- Willing to provide feedback
- Technical capability to deploy (or assistance available)
- Commitment to 3-month pilot period
Apply: Open an issue in lodgebeacon-docs
- Respectful: Treat all contributors with respect
- Inclusive: Welcome diverse perspectives
- Constructive: Provide helpful feedback
- Patient: Remember we're all volunteers
- Masonic: Uphold Masonic values (even if not a Mason)
- Harassment or discrimination
- Trolling or inflammatory comments
- Spam or self-promotion
- Sharing of Masonic secrets (if applicable)
Maintainers will address violations:
- Warning
- Temporary restriction
- Permanent ban
All contributors will be:
- Listed in CONTRIBUTORS.md
- Mentioned in release notes
- Recognized in documentation
Pilot halls will be:
- Listed as "LodgeBeacon Partners"
- Featured in case studies
- Invited to advisory discussions
- General: Open an issue in lodgebeacon-docs
- Technical: Open an issue in relevant repository
- Private: Contact maintainers directly
See individual repositories for license details.
Contributors may be asked to sign a Contributor License Agreement.
- Do not share Masonic secrets or ritual
- Respect the privacy of lodges and halls
- Ensure content is appropriate for Masonic context
Thank you for helping support Masonic halls!
Fraternally,
The LodgeBeacon Team