Skip to content

Commit 7b211b3

Browse files
docs: update readmes for development setup and fixes (#1629)
Co-authored-by: Alexander Song <axiomofjoy@gmail.com>
1 parent 058f604 commit 7b211b3

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

CONTRIBUTING

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The core team is monitoring for pull requests. We will review your pull request
2323
Before submitting a pull request, please make sure the following is done. We expect code authors to test their pull requests well-enough that they work correctly by the time they get to code review. (Note that `npm` commands below are run under the `./app` directory.)
2424

2525
- Fork the repository and create your branch from `main`.
26-
- Follow the [development guide](./DEVELOPMENT.md) to setup your local environment.
26+
- Follow the development guide in [python](./python/DEVELOPMENT.md) or [javascript](./js/DEVELOPMENT.md) to setup your local environment.
2727
- If you've fixed a bug or added code that should be tested, add tests!
2828
- Ensure test suite pass.
2929
- Make sure your code is formatted by a formatter

python/DEVELOPMENT.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,21 @@ This project uses [ruff](https://github.com/astral-sh/ruff) for formatting and l
2828
pip install tox-uv==1.11.2
2929
```
3030

31+
From the root of the repository install development dependencies:
32+
```sh
33+
pip install -r ./python/dev-requirements.txt
34+
```
35+
36+
To compose the `openinference-instrumentation` namespace package with all the instrumentation modules, run the following command:
37+
```sh
38+
tox run -e add_symlinks
39+
```
40+
41+
From the root of the repository install `openinference-instrumentation` package in editable mode with the `-e` flag:
42+
```sh
43+
pip install -e ./python/openinference-instrumentation
44+
```
45+
3146
### Testing
3247

3348
#### Introduction to `tox`

python/openinference-instrumentation/src/openinference/instrumentation/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,8 @@
1515
/openai_agents
1616
/smolagents
1717
/vertexai
18+
/mcp
19+
/portkey
20+
/google_genai
21+
/agno
22+
/beeai

0 commit comments

Comments
 (0)