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

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

This commit is contained in:
James Read 2025-11-22 09:50:55 +00:00 committed by GitHub
parent 40d9377bbd 378db80c73
commit 738ec884d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
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
# - Fedora
dnf install git go protobuf-compiler make -y
dnf install git go protobuf-compiler make pre-commit -y
# - 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
git clone https://github.com/OliveTin/OliveTin.git
cd OliveTin
make githooks
pre-commit install
# Step3: compile binary for current dev env (OS, ARCH)
# `make proto` will also run `make go-tools`, which installs "buf". This binary