diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 00000000..c9b20528 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,12 @@ +# Since version 2.23 (released in August 2019), git-blame has a feature +# to ignore or bypass certain commits. +# +# This file contains a list of commits that are not likely what you +# are looking for in a blame, such as mass reformatting or renaming. +# You can set this file as a default ignore file for blame by running +# the following command. +# +# $ git config blame.ignoreRevsFile .git-blame-ignore-revs + +# Spotless formatting changes +a439cfb7f5a24c5d685b1493d48b6e4cde913751 diff --git a/README.md b/README.md index 6442ff98..4ea5156e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# User Documentation + ## adding submodule In order to use, go to your WPILib project directory (the inner one, where the build.gradle file is), and run the command ``` @@ -39,3 +41,11 @@ git submodule update --init --recursive This command will recursively initialize all submodules. This code is still in development, and apis are still subject to change. The most likely thing to get removed is the swerve api, as ctre recently released their own. + +## Developer Documentation + +To ignore code reformatting when running `git blame` run: + +```shell +git config blame.ignoreRevsFile .git-blame-ignore-revs +```