|
35 | 35 | To be able to use _travis-python_, the Travis machine needs to be configured |
36 | 36 | to be able to run in the three operating systems. |
37 | 37 |
|
38 | | -The easiest way to do it is to [import][travis-config-imports] the shared |
39 | | -configuration snippet: |
| 38 | +The easiest way to do it is to [import the shared configuration snippet]: |
40 | 39 |
|
41 | 40 | ```yaml |
42 | 41 | import: |
@@ -93,12 +92,26 @@ To solve those problems, some directions have been taken: |
93 | 92 | Running tests |
94 | 93 | ------------- |
95 | 94 |
|
96 | | -Use [shellspec] to run unit tests: |
| 95 | +Use [Shellspec] to run unit tests: |
97 | 96 |
|
98 | | -```bash |
| 97 | +```console |
99 | 98 | shellspec |
100 | 99 | ``` |
101 | 100 |
|
| 101 | +Development |
| 102 | +----------- |
| 103 | + |
| 104 | +The following dependencies are required: |
| 105 | + - [ShellCheck] to lint shell scripts, |
| 106 | + - [Shellspec] to run units tests, |
| 107 | + - [Bash] to run the script. |
| 108 | + |
| 109 | +Install the pre-commit hook within your repository: |
| 110 | + |
| 111 | +```console |
| 112 | +poetry run pre-commit install |
| 113 | +``` |
| 114 | + |
102 | 115 | Contributing |
103 | 116 | ------------ |
104 | 117 |
|
@@ -130,5 +143,7 @@ License |
130 | 143 | [ci]: https://travis-ci.org/neimad/travis-python |
131 | 144 |
|
132 | 145 | [travis-python-versions]: https://docs.travis-ci.com/user/languages/python/#specifying-python-versions |
133 | | -[travis-config-imports]: https://docs.travis-ci.com/user/build-config-imports/ |
134 | | -[shellspec]: https://shellspec.info |
| 146 | +[import the shared configuration snippet]: https://docs.travis-ci.com/user/build-config-imports/ |
| 147 | +[Shellspec]: https://shellspec.info/ |
| 148 | +[ShellCheck]: https://www.shellcheck.net/ |
| 149 | +[Bash]: https://www.gnu.org/software/bash/ |
0 commit comments