Skip to content

Commit 933369b

Browse files
committed
updated README with section for developers
1 parent d67227c commit 933369b

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,28 @@ Check [Project Wiki](https://github.com/scrapinghub/shub-workflow/wiki) for docu
2626

2727
The requirements for this library are defined in setup.py as usual. The Pipfile files in the repository don't define dependencies. It is only used
2828
for setting up a development environment for shub-workflow library development and testing.
29+
30+
31+
# For developers
32+
33+
For installing a development environment for shub-workflow, the package comes with Pipfile and Pipfile.lock files. So, clone or fork the repository and do:
34+
35+
```
36+
> pipenv install --dev
37+
> cp pre-commit .git/hooks/
38+
```
39+
40+
for installing the environment, and:
41+
42+
```
43+
> pipenv shell
44+
```
45+
46+
for initiating it.
47+
48+
There is a script, lint.sh, that you can run everytime you need from the repo root folder, but it is also executed each time you do `git commit` (provided
49+
you installed the pre-commit hook during the installation step described above).
50+
51+
```
52+
> ./lint.sh
53+
```

pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
BASE=$(git rev-parse --show-toplevel)
3+
cd $BASE
4+
./lint.sh

0 commit comments

Comments
 (0)