Skip to content

Commit 7fb6101

Browse files
committed
Added Codespaces button inside Contributing.md and used prek instead of pre-commit
1 parent d3ac25b commit 7fb6101

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
"dockerfile": "../Dockerfile"
66
},
77
"runArgs": ["--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"],
8-
"onCreateCommand": "pip install -e . -r requirements-test.txt -r requirements-extra.txt && pre-commit install"
8+
"onCreateCommand": "pip install -e . -r requirements-test.txt -r requirements-extra.txt && prek install"
99
}

CONTRIBUTING.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,14 @@ You can also search this project for issues with the following labels:
1515

1616
### GitHub Codespaces
1717

18-
The repository ships with a dev container configuration, so the easiest way
19-
to get started is [GitHub Codespaces](https://github.com/features/codespaces).
20-
Open the repo on GitHub, click **Code → Codespaces → New codespace**, and wait
21-
for the container to build. Once it's ready, all dependencies will be installed
22-
and pre-commit hooks will be configured automatically.
18+
The repository ships with a dev container configuration that works with
19+
[GitHub Codespaces](https://github.com/features/codespaces). You can open
20+
a ready-to-use environment directly:
21+
22+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/bloomberg/pystack)
23+
24+
Once the codespace is ready, all dependencies will be installed and hooks
25+
will be configured automatically.
2326

2427
Note that the dev container is built from the project's `Dockerfile`, which
2528
compiles `elfutils` from source, so the first build takes a few minutes.
@@ -39,7 +42,7 @@ cd pystack
3942
python3 -m venv ../pystack-env/
4043
source ../pystack-env/bin/activate
4144
pip install -e . -r requirements-test.txt -r requirements-extra.txt
42-
pre-commit install
45+
prek install
4346
```
4447

4548
## Contribution Licensing

0 commit comments

Comments
 (0)