Firstly we are really grateful to you that you are considering contributing to Uli. We welcome contributions of all sorts - filing a bug report, suggesting improvements, proposing new feature, adding documentations, writing tests etc.
By contributing to Uli, you are agreeing to our community guidelines
Contributing to Uli takes 4 easy steps
👋 Say Hi
🔨 Do your thing
📞 Tell us
🎉 Celebrate
The very first thing you should do is letting us know that you are interested in contributing by the following means :
If you are unsure about how to contribute to Uli, simply join our slack, introduce yourself and mention what interests you about the project. We'll reach out and assist you further.
If there's a particular improvement or feature you want to suggest, or a bug in Uli you want to fix, simply create a Github Issue regarding it and we'll reach out to assist you further.
If you are interested in knowing what we are working on right now, head over to the project page. If any issue there interests you, comment on it for any clarification.
If you are leaning towards working on our codebase, you might find our learning guide useful. This will help you expedite whatever you need to learn to be an effective contributor.
You should be able to run Uli on your own machine by following the instructions on one of our setup guides. If you prefer, we have a video tutorial as well. Once you have identified the issue you want to work on, make a fork of our repository and get to coding.
We offer pair programming sessions with community members to familiarize them with the product and the code base. This will give you an opportunity to clarify any doubts regarding the codebase and the features that interest you. Do ping us on the issue or on slack if you would like to sign up for it.
All code changes happen via pull request. We use Github Flow. The easiest way to let us know if you want to combine your changes into the core code is to make a Pull Request (PR)
In your PR, please mention the following :
- What does this PR do?
- How do we test this PR?
We don't strictly follow test driven development (TDD) but any contributions that include tests are greatly appreciated.
We typically review a PR within 2-5 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee/tea on slack 🙂
When you submit code changes, your submissions are understood to be under the same licence that covers the project - GPL-3. Feel free to contact the maintainers if that's a concern.