From 25a92d710e6258ca36d9d69a1ba019fe3082ba3c Mon Sep 17 00:00:00 2001 From: Jakob Scheid Date: Mon, 21 Sep 2026 22:27:28 +0200 Subject: [PATCH] chore: add setup script Added a setup script in scripts/ to configure Git to use the commit message template and added a reference to it to README.md. --- README.md | 4 ++++ scripts/setup.sh | 15 +++++++++++++++ 2 files changed, 19 insertions(+) create mode 100755 scripts/setup.sh diff --git a/README.md b/README.md index 079d125..133076d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ You can install it using pip: pip install jcloud-docsgen --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple/ ``` +## Setup + +Please execute `scripts/setup.sh` when cloning the repository to configure Git. + ## Reference API reference and generated documentation can be found in [docs/reference](docs/reference). diff --git a/scripts/setup.sh b/scripts/setup.sh new file mode 100755 index 0000000..9d00bb6 --- /dev/null +++ b/scripts/setup.sh @@ -0,0 +1,15 @@ +# Copyright 2026 jCloud + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# http://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +git config --local commit.template .gitmessage