Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NO-SNOW Update the contributor notes with instructions about ast.proto #3005

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

NO-SNOW Update the contributor notes with instructions about ast.proto #3005

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ cd snowpark-python
conda create --name snowpark-dev python=3.9
```

- We recommend installing the following packages: `tox`, `protoc-wheel-0==21.1` and `mypy-protobuf`.

- Activate the new Python virtual environment. For example,

```bash
Expand Down Expand Up @@ -83,6 +85,12 @@ and "Mark Directory as" -> "Source Root". **NOTE**: VS Code doesn't have "Source

[Configure PyCharm interpreter][config pycharm interpreter] or [Configure VS Code interpreter][config vscode interpreter] to use the previously created Python virtual environment.

### Protobuf generation

When switching between revisions with `git switch` or `git checkout`, and when
setting up the repository for the first time, update the generated `ast_pb2.py`
from `ast.proto` with `python -m tox -e protoc`.

### Thread-safe development

This section covers guidelines for developers that wish to contribute code to `Session`, `ServerConnection`, `MockServerConnection` and other related objects that are critical to correct functionality of `snowpark-python`.
Expand Down
Loading