From 3d665bdde2e837f4cc3f4fdb86f3125b1dd46695 Mon Sep 17 00:00:00 2001 From: Declan Teevan Date: Thu, 5 Sep 2024 00:12:34 +0100 Subject: [PATCH] feat: add formatting pre-commit hook --- .pre-commit-config.yaml | 11 +++++++++++ README.md | 6 ++++++ 2 files changed, 17 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..011ecaf --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,11 @@ +repos: + - repo: https://github.com/dnephin/pre-commit-golang + rev: v0.5.1 + hooks: + - id: go-fmt + args: [-s, -w] + + - repo: https://github.com/bufbuild/buf + rev: v1.28.1 + hooks: + - id: buf-format diff --git a/README.md b/README.md index fbe550c..95becfe 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,12 @@ Any ideas, suggestions or direct contributions to better conform with general an * API gateway pattern using Envoy * Distributed transactions utilising the saga pattern +## ⚠️ Notice + +As this project is licensed under the GNU Affero General Public License v3, [copying, templating or referencing code from this project](https://en.wikipedia.org/wiki/Clean-room_design) may violate international copyright law unless your project is using a compatible open-source license. Please ensure any implementation in your own projects is original and complies with applicable licenses and laws. + +In the nature of open-source software, please consider contributing and giving back to the project to help make it better for the greater community, especially if you see it as a useful learning resource. + ## 🗃️ Architecture ### 🔎 Overview