Skip to content

Commit

Permalink
chore(weave): Add note on providing reproducible examples (#2647)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtruong authored Oct 9, 2024
1 parent b22a408 commit 705b6f4
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 4 deletions.
22 changes: 18 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Contributing to `weave`

- [Contributing to `weave`](#contributing-to-weave)
- [Issues and PRs](#issues-and-prs)
- [Issues](#issues)
- [PRs](#prs)
- [Conventional Commits](#conventional-commits)
- [Types](#types)
- [Setting up your environment](#setting-up-your-environment)
Expand All @@ -11,10 +12,23 @@
- [Testing](#testing)
- [Deprecating features](#deprecating-features)

## Issues and PRs

## Issues
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!
2. If you are a first-time contributor, welcome! To get started, make a fork and point to the main `weave` repo:
2. If you're having issues, the best way we can help is when you can share a reproducible example.
1. In general, it's helpful use this format:
```
<short description of the issue>
<link to your project>
<system info, including weave version, python version, and OS>
<reproducible code snippet>
<any other info you think is relevant>
```
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/).
## PRs
1. If you are a first-time contributor, welcome! To get started, make a fork and point to the main `weave` repo:
```sh
git clone https://github.com/<your-username>/weave.git
cd weave
Expand Down
17 changes: 17 additions & 0 deletions examples/contributing/example_error_script.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# /// script
# requires-python = ">=3.10"
# dependencies = [
# "openai",
# ]
# ///

import openai


def main():
print("hello", openai.__version__)
raise


if __name__ == "__main__":
main()

0 comments on commit 705b6f4

Please sign in to comment.