Skip to content

Commit 705b6f4

Browse files
authoredOct 9, 2024··
chore(weave): Add note on providing reproducible examples (#2647)
1 parent b22a408 commit 705b6f4

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed
 

‎CONTRIBUTING.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Contributing to `weave`
22

33
- [Contributing to `weave`](#contributing-to-weave)
4-
- [Issues and PRs](#issues-and-prs)
4+
- [Issues](#issues)
5+
- [PRs](#prs)
56
- [Conventional Commits](#conventional-commits)
67
- [Types](#types)
78
- [Setting up your environment](#setting-up-your-environment)
@@ -11,10 +12,23 @@
1112
- [Testing](#testing)
1213
- [Deprecating features](#deprecating-features)
1314

14-
## Issues and PRs
15-
15+
## Issues
1616
1. Check the [issues](https://github.com/wandb/weave/issues) and [PRs](https://github.com/wandb/weave/pulls) to see if the feature/bug has already been requested/fixed. If not, [open an issue](https://github.com/wandb/weave/issues/new/choose). This helps us keep track of feature requests and bugs!
17-
2. If you are a first-time contributor, welcome! To get started, make a fork and point to the main `weave` repo:
17+
2. If you're having issues, the best way we can help is when you can share a reproducible example.
18+
1. In general, it's helpful use this format:
19+
```
20+
<short description of the issue>
21+
<link to your project>
22+
<system info, including weave version, python version, and OS>
23+
24+
<reproducible code snippet>
25+
26+
<any other info you think is relevant>
27+
```
28+
2. For SDK issues, a reproducible script like [example_error_script.py](examples/contributing/example_error_script.py) is helpful. We use `uv` which can run the script with the dependencies included. If you know the dependencies, you can add them to the script. [See the `uv` docs for more details](https://docs.astral.sh/uv/guides/scripts/).
29+
30+
## PRs
31+
1. If you are a first-time contributor, welcome! To get started, make a fork and point to the main `weave` repo:
1832
```sh
1933
git clone https://github.com/<your-username>/weave.git
2034
cd weave
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# /// script
2+
# requires-python = ">=3.10"
3+
# dependencies = [
4+
# "openai",
5+
# ]
6+
# ///
7+
8+
import openai
9+
10+
11+
def main():
12+
print("hello", openai.__version__)
13+
raise
14+
15+
16+
if __name__ == "__main__":
17+
main()

0 commit comments

Comments
 (0)
Please sign in to comment.