BCar library
============

[![builds.sr.ht status](https://builds.sr.ht/~qeef.svg)](https://builds.sr.ht/~qeef?)

BCar is a Rust library with basic bicycle car computations. The project is
published under [MIT License][].

[MIT License]: ./LICENSE

Contribute
==========

Use [OneFlow][1] branching model and keep the [changelog][2].

Write [great git commit messages][3]:

1. Separate subject from body with a blank line.
2. Limit the subject line to 50 characters.
3. Capitalize the subject line.
4. Do not end the subject line with a period.
5. Use the imperative mood in the subject line.
6. Wrap the body at 72 characters.
7. Use the body to explain what and why vs. how.

When adding feature or hotfix, use [Test-driven development (TDD)][4]:

1. Add unit test and skeleton.
2. Run tests (`cargo test`), check that the test *fail*.
3. Code now. Implement functionality.
4. Run tests again, check that the test *pass*.
5. Refactor.

Document new functions, methods, structs, and files. Use *Examples* section as
basic unit tests.

[1]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
[2]: ./CHANGELOG.md
[3]: https://chris.beams.io/posts/git-commit/
[4]: https://en.wikipedia.org/wiki/Test-driven_development