feat: Add gitignore template

This commit is contained in:
Blake Ridgway 2025-06-11 20:50:20 -05:00
commit 00424ea4c1
10 changed files with 1053 additions and 0 deletions

50
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,50 @@
# 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](CODE_OF_CONDUCT.md).
## How Can I Contribute?
### Reporting Bugs
- **Ensure the bug was not already reported** by searching on GitLab under
[Issues](https://gitlab.com/rideaware/[repo-name]/-/issues).
- If you're unable to find an open issue addressing the problem,
[open a new one](https://gitlab.com/rideaware/[repo-name]/-/issues/new).
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
1. Fork the project and create your branch from `main`:
`git checkout -b feature/AmazingFeature` or `bugfix/FixThatBug`.
2. Make your changes. Please write clean code and add comments where necessary.
3. Update the `README.md` with details of changes to the interface, if
applicable.
4. Add or update tests to ensure your changes are covered.
5. Ensure all tests pass locally before pushing.
6. Commit your changes with a descriptive commit message.
7. Push to the branch: `git push origin feature/AmazingFeature`.
8. Open a Merge Request to the `main` branch of the original repository.
9. A project maintainer will review your Merge Request.
Thank you for your contribution!