diff --git a/README.md b/README.md index 298cbf67..c820fa65 100644 --- a/README.md +++ b/README.md @@ -207,6 +207,8 @@ file the Contributor License Agreement before sending any pull requests (PRs). Of course, if you're new to the project, it's usually best to discuss any proposals and reach consensus before sending your first PR. +Source code is [auto-formatted](/doc/note/auto-formatting.md). + # License diff --git a/doc/note/auto-formatting.md b/doc/note/auto-formatting.md new file mode 100644 index 00000000..59eb3d40 --- /dev/null +++ b/doc/note/auto-formatting.md @@ -0,0 +1,6 @@ +# Auto-Formatting + +Within this repository: +- `C` code is formatted by `clang-format-5.0 -style=Chromium"`. +- `Go` code is formatted by `gofmt`. +- `Wuffs` code is formatted by [`wuffsfmt`](/cmd/wuffsfmt).