diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0eac89c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing guide + + +## Commit message format +The project uses [this](https://www.conventionalcommits.org/en/v1.0.0/) +commit message standard: +```gitcommit +(): + +[optional body] + +[optional footer] +``` + + + +## Git Tag format +A tag is set on the commit for the next version release in [Semantic +Versioning](https://semver.org/) format: `MAJOR.MINOR.PATCH` with the prefix +`v` (e.g., `v0.1.2`). +```sh +git tag -a 'v0.1.2' -m "Fix v0.1.2" +git push --tags +``` + +When releasing a new version, all changes must be documented in +[CHANGELOG.md](CHANGELOG.md) + + +## Обновление конфига +```sh +. ~/playground/esp-idf/export.sh +idf.py save-defconfig +git add sdkconfig.defaults +``` diff --git a/README.md b/README.md index 7afa621..d7626eb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ +# Pump controller ESP32 - - - -Сохранение конфига: +## Сборка и прошивка ```sh -. ~/playground/esp-idf/export.sh -idf.py save-defconfig +PORT="/dev/ttyUSB0" \ +ESP_IDF="~/playground/esp-idf/" +just build flash ``` diff --git a/justfile b/justfile index 6b7a83f..94ade5f 100755 --- a/justfile +++ b/justfile @@ -1,17 +1,17 @@ #!/usr/bin/env -S just --justfile PORT := env("PORT", "/dev/ttyUSB0") -ESPRESSIF := env("ESPRESSIF", "${HOME}/playground/esp-idf") +ESP_IDF := env("ESP_IDF", "${HOME}/playground/esp-idf") init: #!/bin/sh - . "{{ESPRESSIF}}/export.sh" + . "{{ESP_IDF}}/export.sh" idf.py set-target esp32 build: #!/bin/sh - . "{{ESPRESSIF}}/export.sh" + . "{{ESP_IDF}}/export.sh" xxd -i assets/index.html > main/frontend.h idf.py build @@ -19,12 +19,12 @@ build: alias flash := upload upload: #!/bin/sh - . "{{ESPRESSIF}}/export.sh" + . "{{ESP_IDF}}/export.sh" idf.py -p "{{PORT}}" flash alias term := monitor monitor: #!/bin/sh - . "{{ESPRESSIF}}/export.sh" + . "{{ESP_IDF}}/export.sh" idf.py -p "{{PORT}}" monitor