First off, thank you for considering contributing to MyLibreLab. It's people like you that make open source possible! 🎉
MyLibreLab is an open source project, and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into MyLibreLab itself.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
- Ensure that code that goes into core meets all quality standards.
- Read our code guidelines.
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
Unsure where to begin contributing to MyLibreLab? You can start by looking through these labels!
- good first issue - issues which should only require a few lines of code, and a test or two.
- help wanted - issues which should be a bit more involved than good first issues.
Working on your first Pull Request? You can check these resources:
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first! 🎉
- Create your own fork of the code.
- Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
- To comply with our style guidelines use
./gradlew autostyleApply. PRs should not include commits with autostyle runs. Instead, fix any style violations before committing changes. - Each pull request should be clear, concise and informative: Please consider checking these resources: writing a great pull request and unwritten guide to pull requests
- Each pull request should implement one feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
- Each commit name and message should be clear, concise and informative: Please consider checking these resources: writing a commit message and writing a good commit message
- Each commit should be small, contained and should solve only one problem.
- Pull request should not include any merge commits. To update the branch of your pull request use
git pull --rebase.
You can chat with the MyLibreLab users and devs in our discord server!