Thank you for considering contributing to REBL. We are a team of software engineers and data-science geeks with a passion for cycling. We love and respect the history, traditions and culture of cycling today, but also think that modern technology could be used to enable a better future.
We are 100% committed to making it fun and ensuring that its always a nice place to spend time for everyone involved. If you contribute we insist you will embrace that same spirit.
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.
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 REBL itself. Before you jump in please make sure you understand our simple community guidelines.
Being nice costs nothing but makes a big difference. Always be nice. Always. That doesn't mean you have to shy away from often uncomfortable direct technical feedback or sharing differences in opinions; just do it nicely. Fair warning : if you are not nice, we will simply remove you from the project no matter how smart you are.
Collaboration is central to REBL and to the larger free software community. That means being transparent and open about what you are working on and expecting to work with others at all times.
Nobody knows everything, and nobody is expected to be perfect. Asking questions avoids many problems down the road, and so questions are encouraged. Those who are asked questions should be responsive and helpful. Likewise letting others know what you are working on helps everyone avoid wasting valuable time.
If you are ready to contribute, the first thing you should do is sign up to the developers Slack channel and introduce yourself. You can ask about tasks that need to be done or suggest things that you want to work on. Most open source projects have a lot of people saying they are going to work on tasks but in reality sadly very few actually do so we recommend working on and delivering smaller tasks and building a track record with the core team before suggesting ambitious ideas.Join OUR slack channel
All contributions are required to sign a standard Contributor License Agreement. This happens when you submit your PR and before it can be reviewed. The CLA assigns copyright to the projects Public Benefit Corporation that has been setup to govern the project.
Code Contributions are made through Git Pull Requests. Create your own fork of the code, make your changes and submit a PR for review. Before working on any code contributions we strongly suggest you announce your work on the Slack channel to avoid duplication.
Small changes such as typos should be submitted directly as a GitHub issue. Bugs should be submitted as a GitHub issue.
If you think you have discovered a security issue do NOT submit a GitHub issue but email email@example.com.
Feature requests and ideas should be discussed on the developers Slack channel.
The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.