We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
This document introduces contribution practices for ftrucli.
We use github to host code, track issues and feature requests, and accept pull requests.
We Use Release Flow
Pull requests are the best way to propose changes to the codebase (we use Release Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
Report bugs using GitHub's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
Write bug reports with detail, background, and sample code
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
See Linting to learn about this project's enforced coding style.
By contributing, you agree that your contributions will be licensed under its MIT License.
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.
Public data from San Francisco's SODA endpoint is covered under the Public Domain Dedication and License, see the LICENSE-DATA file.
This template (and—by the transitive property—this template too) was used in the creation of this document.