Update README #38
Merged
Update README #38
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ssmith-pc
reviewed
Jul 30, 2024
CONTRIBUTING.md
Outdated
Comment on lines
12
to
39
| ### Clone the repository | ||
|
|
||
| This repository relies on a git submodule to get access to our openapi spec. To clone the repository, use the command: | ||
|
|
||
| ``` | ||
| git clone --recurse-submodules [email protected]:pinecone-io/pinecone-rust-client.git | ||
| ``` | ||
|
|
||
| Or, if you have already cloned the repository, you can update the submodules with | ||
|
|
||
| ``` | ||
| git submodule update --init --recursive | ||
| ``` | ||
|
|
||
| ### Generating code from OpenAPI and Proto specs | ||
|
|
||
| The generated code is already checked into the repository, but it can be regenerated by following these steps. | ||
|
|
||
| You will require access to the `apis` repository. | ||
| - Follow setup instructions for the `apis` repository: [apis setup](https://github.com/pinecone-io/apis) | ||
|
|
||
| OpenAPI | ||
|
|
||
| - You need [Docker Desktop](https://www.docker.com/products/docker-desktop/) in order to generate code using openapi. Look at `codegen/build-oas.sh` to see how this is used. | ||
| - Make sure Docker is running. | ||
| - `just build-openapi` | ||
| - References the spec files from the `codegen/apis` submodule | ||
| - Outputs the generated code to `src/openapi` |
There was a problem hiding this comment.
Just to confirm developer experience if someone doesn't have access to our apis repo -- Are they still able to contribute fixes? They just couldn't run the build-protos step, right?
There was a problem hiding this comment.
I believe that's the case, yeah. We should make that explicit in the documentation (I'm working on the same thing in Go atm for the CONTRIBUTING.md).
My understanding is since we check in the generated code, and there's no dependency on the submodule for general development, this shouldn't hinder folks who are looking to submit changes publicly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Lacking detail in README and did not have a CONTRIBUTING file
Solution
This PR updates the README and adds a CONTRIBUTING file. Also updates some metadata in Cargo.toml
Type of Change
Test Plan
Does not change functional code, all existing test cases pass.