Contributing to RideAware Projects

First off, thank you for considering contributing! It's people like you that make RideAware a great community.

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.

Code of Conduct

We take our community and our code of conduct seriously. By participating, you are expected to uphold this code. Please report unacceptable behavior to blake@rideaware.org. Read our full CODE_OF_CONDUCT.md.

How Can I Contribute?

Reporting Bugs

Ensure the bug was not already reported by searching on GitLab under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

Open a new issue, clearly describing the enhancement and the motivation for it.
Use a clear and descriptive title for the issue to identify the suggestion.

Merge Request Process

Fork the project and create your branch from main: git checkout -b feature/AmazingFeature or bugfix/FixThatBug.
Make your changes. Please write clean code and add comments where necessary.
Update the README.md with details of changes to the interface, if applicable.
Add or update tests to ensure your changes are covered.
Ensure all tests pass locally before pushing.
Commit your changes with a descriptive commit message.
Push to the branch: git push origin feature/AmazingFeature.
Open a Merge Request to the main branch of the original repository.
A project maintainer will review your Merge Request.

Thank you for your contribution!

2.1 KiB Raw Blame History