-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7c3b291
commit 1e6f7f4
Showing
1 changed file
with
17 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,18 @@ | ||
# robot-2021 | ||
# robot-2021-offseason | ||
|
||
[![Formatting (pre-commit)](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/format.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/format.yaml?query=branch%3Amain) | ||
[![Build And Test](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/build_and_test.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/build_and_test.yaml?query=branch%3Amain) | ||
[![Formatting (pre-commit)](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/format.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/format.yaml?query=branch%3Amain) | ||
[![Build And Test](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/build_and_test.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/build_and_test.yaml?query=branch%3Amain) | ||
|
||
**Formatting with pre-commit** | ||
|
||
pre-commit is a tool that is used in this repository to check and apply style guidelines automatically. To install pre-commit into your system: | ||
|
||
pip3 install pre-commit | ||
|
||
Then under root directory install the git hooks like this: | ||
|
||
pre-commit install | ||
|
||
With this pre-commit will automatically run and check a list of styling including clang-format, end of files and trailing whitespaces whenever you run `git commit`. To run pre-commit any time other than `git commit`: | ||
|
||
pre-commit run -a |