Contributing
Thank you for contributing to Lakreet!
Ways to contribute
- Bug reports — include
lakreet-swarm doctoroutput - Feature requests — check Roadmap first
- Documentation — fix typos, add examples, translate
- Code — PRs welcome, follow style guide
- Testing — run
npm run smokeon new EffectCraft versions
Development setup
bash
# Lakreet-swarm
git clone https://github.com/Lakreet/lakreet-swarm.git
cd lakreet-swarm
npm install
npm run checkall # format, lint, test, smokeCode style
- TypeScript (strict), ESLint + Prettier
npm run formatbefore commit- No shell execution (array args only)
- Tests for new features
Pull request process
- Fork & branch
- Make changes
npm run checkallpasses- Update docs if needed
- Open PR with description
Issue templates
- Bug: include
doctoroutput, steps to reproduce - Feature: use case, alternatives considered
- Docs: page URL, what's wrong/missing
Community
- GitHub Discussions for questions
- GitHub Issues for bugs/features
- Be respectful — see Code of Conduct
Next steps
- Code of Conduct
- Security — vulnerability reporting
- Support — where to get help