docs(contributor_guide): Update install pre-commit instructions

pull/11819/head
Tomas Sebestik 2023-06-28 13:41:49 +02:00
rodzic b4c84e09e2
commit c59d4e15ff
4 zmienionych plików z 15 dodań i 10 usunięć

Wyświetl plik

@ -1,7 +1,9 @@
const { minimumSummaryChars } = require("./mrCommitsConstants.js");
const { maximumSummaryChars } = require("./mrCommitsConstants.js");
const { maximumBodyLineChars } = require("./mrCommitsConstants.js");
const { allowedTypes } = require("./mrCommitsConstants.js");
const {
minimumSummaryChars,
maximumSummaryChars,
maximumBodyLineChars,
allowedTypes,
} = require("./mrCommitsConstants.js");
const { gptStandardModelTokens } = require("./mrCommitsConstants.js");
const { ChatPromptTemplate } = require("langchain/prompts");

Wyświetl plik

@ -1,7 +1,9 @@
const { minimumSummaryChars } = require("./mrCommitsConstants.js");
const { maximumSummaryChars } = require("./mrCommitsConstants.js");
const { maximumBodyLineChars } = require("./mrCommitsConstants.js");
const { allowedTypes } = require("./mrCommitsConstants.js");
const {
minimumSummaryChars,
maximumSummaryChars,
maximumBodyLineChars,
allowedTypes,
} = require("./mrCommitsConstants.js");
/**
* Check that commit messages are based on the Espressif ESP-IDF project's rules for git commit messages.
@ -141,6 +143,7 @@ module.exports = async function () {
\n**Please consider updating these commit messages** - here are some basic tips:\n${basicTips.join(
"\n"
)}
\n \`TIP:\` You can install commit-msg pre-commit hook (\`pre-commit install -t pre-commit -t commit-msg\`) to run this check when committing.
\n***
`;

Wyświetl plik

@ -169,7 +169,7 @@ repos:
- id: check-copyright
args: ['--ignore', 'tools/ci/check_copyright_ignore.txt', '--config', 'tools/ci/check_copyright_config.yaml']
- repo: https://github.com/espressif/conventional-precommit-linter
rev: v1.1.0
rev: v1.2.0
hooks:
- id: conventional-precommit-linter
stages: [commit-msg]

Wyświetl plik

@ -18,7 +18,7 @@ Install pre-commit hook
1. Go to the IDF Project Directory
2. Run ``pre-commit install --allow-missing-config``. Install hook by this approach will let you commit successfully even in branches without the ``.pre-commit-config.yaml``
2. Run ``pre-commit install --allow-missing-config -t pre-commit -t commit-msg``. Install hook by this approach will let you commit successfully even in branches without the ``.pre-commit-config.yaml``
3. pre-commit hook will run automatically when you're running ``git commit`` command