epistemophiliac/frappe_docker
1
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2026-06-26 09:05:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Add guide to CONTRIBUTING.md

Browse source
This commit is contained in:
Lev Vereshchagin 2021-12-05 19:09:08 +03:00
parent 14d0c0ae42
commit 6e0f6ec77a
1 changed files with 24 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md
View file

@ -10,12 +10,35 @@ On each PR that contains changes relevant to Docker builds, images are being bui
> :evergreen_tree: Please be considerate when pushing commits and opening PR for multiple branches, as the process of building images uses energy and contributes to global warming. > :evergreen_tree: Please be considerate when pushing commits and opening PR for multiple branches, as the process of building images uses energy and contributes to global warming.
> >
## Lint ## Lint
We use `pre-commit` framework to lint the codebase before committing.
First, you need to install pre-commit with pip:
```shell ```shell
shellcheck example.sh pip install pre-commit
``` ```
Also you can use brew if you're on Mac:
```shell
brew install pre-commit
```
To setup _pre-commit_ hook, run:
```shell
pre-commit install
```
To run all the files in repository, run:
```shell
pre-commit run --all-files
```
## Build ## Build
```shell ```shell