medlogic
/
olivetin
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(contributing): update setup instructions for pre-commit 

Update CONTRIBUTING guide to reflect migration from custom git hooks to
standard pre-commit framework:

* Add pre-commit package to installation commands for Fedora and Windows
* Replace 'make githooks' with standard 'pre-commit install' command

This completes the migration to pre-commit started in previous refactor
commit, ensuring documentation matches current development workflow.
This commit is contained in:
Anton Bobov 2025-11-20 00:00:38 +05:00
parent c2843aa581
commit 378db80c73
No known key found for this signature in database
GPG Key ID: B4DCCEF7CE0E6AF3
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.adoc
View File

@ -35,14 +35,14 @@ The preferred way to communicate is probably via Discord or GitHub issues.
``` ```
# Step1: setup compile env # Step1: setup compile env
# - Fedora # - Fedora
dnf install git go protobuf-compiler make -y dnf install git go protobuf-compiler make pre-commit -y
# - Windows with chocolatey # - Windows with chocolatey
choco install git go protoc make python nodejs-lts -y choco install git go protoc make python nodejs-lts -y && pip install pre-commit
# Step2: clone and setup repo # Step2: clone and setup repo
git clone https://github.com/OliveTin/OliveTin.git git clone https://github.com/OliveTin/OliveTin.git
cd OliveTin cd OliveTin
make githooks pre-commit install
# Step3: compile binary for current dev env (OS, ARCH) # Step3: compile binary for current dev env (OS, ARCH)
# `make proto` will also run `make go-tools`, which installs "buf". This binary # `make proto` will also run `make go-tools`, which installs "buf". This binary