You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,40 @@ You can also search this project for issues with the following labels:
11
11
|[help wanted](https://github.com/bloomberg/pystack/search?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+&type=Issues&utf8=%E2%9C%93)|`is:issue is:open label:"help wanted"`| General issues where contributors help is wanted. |
12
12
|[question](https://github.com/bloomberg/pystack/search?q=is%3Aissue+is%3Aopen+label%3Aquestion&type=Issues&utf8=%E2%9C%93)|`is:issue is:open label:question`| Open discussions to resolve everything from implementation details to desired functionality. |
13
13
14
+
## Setting up a development environment
15
+
16
+
### GitHub Codespaces
17
+
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
+
[](https://codespaces.new/bloomberg/pystack)
23
+
24
+
Once the codespace is ready, all dependencies will be installed and hooks
25
+
will be configured automatically.
26
+
27
+
Note that the dev container is built from the project's `Dockerfile`, which
28
+
compiles `elfutils` from source, so the first build takes a few minutes.
29
+
30
+
pystack requires elevated ptrace permissions to inspect processes — the dev
31
+
container already handles this via `--cap-add=SYS_PTRACE` and
32
+
`seccomp=unconfined`, so things should work out of the box.
33
+
34
+
### Local setup
35
+
36
+
You'll need Linux with `libdw`, `libelf`, CMake, and a C++ compiler (Clang or
0 commit comments