Skip to content

Latest commit

 

History

History
11 lines (7 loc) · 871 Bytes

CONTRIBUTING.md

File metadata and controls

11 lines (7 loc) · 871 Bytes
Raw

Contributing

Pull requests are welcome. Please submit them to the develop branch, and ensure you're rebased to the latest changes in the repo.

Consider familiarizing yourself with trafficjam's architecture before getting started.

Please run the tests before submitting a PR. There are two dependencies for testing: bats (v1.2.1) and shellcheck (v0.7.0 is used in CI, but newer versions are fine too). The tests can be run with bats test/test.bats

For information on how trafficjam and its tests are structured, please see ARCHITECTURE.md

Style

Please follow the coding style that is used. Since this is a bash script, use tabs for indentation. For readability and ease of understanding, use long forms of arguments where possible.