RomanNum3ral
/
scrapy
mirror of https://github.com/scrapy/scrapy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

explaining pre-commit on documentation

This commit is contained in:
Emmanuel Rondan 2023-01-17 14:26:12 -03:00
parent 1ebcd86c04
commit 482a0b79e3
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/contributing.rst
View File

@ -179,6 +179,25 @@ Scrapy:
See https://help.github.com/en/github/using-git/setting-your-username-in-git for
setup instructions.
.. _pre-commit:
Pre-commit
==========
Pre-commit is a tool that allows developers to specify a set of checks to be run
automatically every time they make a commit. This can include code style checks,
linting, and automated tests.
The checks are defined in a configuration file called .pre-commit-config.yaml.
By using pre-commit, developers can ensure that their code adheres to a consistent
style and passes certain tests before they make a commit.
This can help catch errors early in the development process and prevent them
from being pushed to the main branch.
To use pre-commit, developers first need to install it on their local machine.
Once it is installed, they can specify the checks they want to run in the .pre-commit-config.yaml file.
After that, pre-commit will run automatically every time they make a commit.
.. _documentation-policies:
Documentation policies