mirror of
https://github.com/espressif/esp-idf
synced 2025-03-09 17:19:09 -04:00
docs(contributor_guide): Update install pre-commit instructions
This commit is contained in:
parent
b4c84e09e2
commit
c59d4e15ff
@ -1,7 +1,9 @@
|
|||||||
const { minimumSummaryChars } = require("./mrCommitsConstants.js");
|
const {
|
||||||
const { maximumSummaryChars } = require("./mrCommitsConstants.js");
|
minimumSummaryChars,
|
||||||
const { maximumBodyLineChars } = require("./mrCommitsConstants.js");
|
maximumSummaryChars,
|
||||||
const { allowedTypes } = require("./mrCommitsConstants.js");
|
maximumBodyLineChars,
|
||||||
|
allowedTypes,
|
||||||
|
} = require("./mrCommitsConstants.js");
|
||||||
const { gptStandardModelTokens } = require("./mrCommitsConstants.js");
|
const { gptStandardModelTokens } = require("./mrCommitsConstants.js");
|
||||||
|
|
||||||
const { ChatPromptTemplate } = require("langchain/prompts");
|
const { ChatPromptTemplate } = require("langchain/prompts");
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
const { minimumSummaryChars } = require("./mrCommitsConstants.js");
|
const {
|
||||||
const { maximumSummaryChars } = require("./mrCommitsConstants.js");
|
minimumSummaryChars,
|
||||||
const { maximumBodyLineChars } = require("./mrCommitsConstants.js");
|
maximumSummaryChars,
|
||||||
const { allowedTypes } = require("./mrCommitsConstants.js");
|
maximumBodyLineChars,
|
||||||
|
allowedTypes,
|
||||||
|
} = require("./mrCommitsConstants.js");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check that commit messages are based on the Espressif ESP-IDF project's rules for git commit messages.
|
* 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**Please consider updating these commit messages** - here are some basic tips:\n${basicTips.join(
|
||||||
"\n"
|
"\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***
|
\n***
|
||||||
`;
|
`;
|
||||||
|
|
||||||
|
@ -169,7 +169,7 @@ repos:
|
|||||||
- id: check-copyright
|
- id: check-copyright
|
||||||
args: ['--ignore', 'tools/ci/check_copyright_ignore.txt', '--config', 'tools/ci/check_copyright_config.yaml']
|
args: ['--ignore', 'tools/ci/check_copyright_ignore.txt', '--config', 'tools/ci/check_copyright_config.yaml']
|
||||||
- repo: https://github.com/espressif/conventional-precommit-linter
|
- repo: https://github.com/espressif/conventional-precommit-linter
|
||||||
rev: v1.1.0
|
rev: v1.2.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: conventional-precommit-linter
|
- id: conventional-precommit-linter
|
||||||
stages: [commit-msg]
|
stages: [commit-msg]
|
||||||
|
@ -18,7 +18,7 @@ Install pre-commit hook
|
|||||||
|
|
||||||
1. Go to the IDF Project Directory
|
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
|
3. pre-commit hook will run automatically when you're running ``git commit`` command
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user