We deeply appreciate your interest in contributing to lume! Whether you're reporting bugs, suggesting enhancements, improving docs, or submitting pull requests, your contributions help improve the project for everyone.
If you've encountered a bug in the project, we encourage you to report it. Please follow these steps:
- Check the Issue Tracker: Before submitting a new bug report, please check our issue tracker to see if the bug has already been reported.
- Create a New Issue: If the bug hasn't been reported, create a new issue with:
- A clear title and detailed description
- Steps to reproduce the issue
- Expected vs actual behavior
- Your environment (macOS version, lume version)
- Any relevant logs or error messages
- Label Your Issue: Label your issue as a
bugto help maintainers identify it quickly.
We're always looking for suggestions to make lume better. If you have an idea:
- Check Existing Issues: See if someone else has already suggested something similar.
- Create a New Issue: If your enhancement is new, create an issue describing:
- The problem your enhancement solves
- How your enhancement would work
- Any potential implementation details
- Why this enhancement would benefit lume users
Documentation improvements are always welcome. You can:
- Fix typos or unclear explanations
- Add examples and use cases
- Improve API documentation
- Add tutorials or guides
For detailed instructions on setting up your development environment and submitting code contributions, please see our Development.md guide.
Feel free to join our Discord community to discuss ideas or get help with your contributions.