Skip to content

Commit d0c8ce5

Browse files
Update maintainers_guide.md
1 parent 1fb9ba1 commit d0c8ce5

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

.github/maintainers_guide.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ this project. If you use this package within your own software as is but don't p
1010

1111
We recommend using [pyenv](https://github.com/pyenv/pyenv) for Python runtime management. If you use macOS, follow the following steps:
1212

13-
```zsh
13+
```sh
1414
brew update
1515
brew install pyenv
1616
```
1717

1818
Install necessary Python runtimes for development/testing. You can rely on GitHub Actions for testing with various major versions.
1919

20-
```zsh
20+
```sh
2121
pyenv install -l | grep -v "-e[conda|stackless|pypy]"
2222

2323
pyenv install 3.9.18 # select the latest patch version
@@ -34,7 +34,7 @@ pyenv rehash
3434

3535
Then, you can create a new Virtual Environment this way:
3636

37-
```zsh
37+
```sh
3838
python -m venv env_3.9.18
3939
source env_3.9.18/bin/activate
4040
```
@@ -49,38 +49,38 @@ If you make some changes to this project, please write corresponding unit tests
4949

5050
If this is your first time to run tests, although it may take a bit longer, running the following script is the easiest.
5151

52-
```zsh
52+
```sh
5353
./scripts/install_and_run_tests.sh
5454
```
5555

5656
To simply install all the development dependencies for this project.
5757

58-
```zsh
58+
```sh
5959
./scripts/install.sh
6060
```
6161

6262
Once you installed all the required dependencies, you can use the following.
6363

64-
```zsh
64+
```sh
6565
./scripts/run_tests.sh
6666
./scripts/run_tests.sh tests/scenario_test/test_get_hooks.py
6767
```
6868

6969
To format this project
7070

71-
```zsh
71+
```sh
7272
./scripts/format.sh
7373
```
7474

7575
To lint this project
7676

77-
```zsh
77+
```sh
7878
./scripts/lint.sh
7979
```
8080

8181
This project uses [mypy](https://mypy.readthedocs.io/en/stable/index.html) to check and infers types for your Python code.
8282

83-
```zsh
83+
```sh
8484
./scripts/run_mypy.sh
8585
```
8686

@@ -92,7 +92,7 @@ If you want to test the package locally you can.
9292

9393
- Run
9494

95-
```zsh
95+
```sh
9696
scripts/build_pypi_package.sh
9797
```
9898

@@ -103,7 +103,7 @@ If you want to test the package locally you can.
103103
- Example `/dist/slack_cli_hooks-1.2.3-py2.py3-none-any.whl` was created
104104
- From anywhere on your machine you can install this package to a project with
105105

106-
```zsh
106+
```sh
107107
pip install <project path>/dist/slack_cli_hooks-1.2.3-py2.py3-none-any.whl
108108
```
109109

0 commit comments

Comments
 (0)