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

Jump to bottom

Remove .env.example, update CONTRIBUTING.md #62

Merged
merged 2 commits into from
Aug 6, 2024
Merged

Remove .env.example, update CONTRIBUTING.md #62

merged 2 commits into from
Aug 6, 2024

Conversation

austin-denoble
Copy link
Contributor

Problem

Within the SDK itself we're not reading anything from an .env file, but the repo still has an example file that's referenced in the CONTRIBUTING.md file.

Solution

Remove .env.example and update the section about setting up your environment in the CONTRIBUTING.md file.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

N/A

@austin-denoble austin-denoble requested a review from aulorbe August 5, 2024 22:32
aulorbe
aulorbe reviewed Aug 5, 2024
View reviewed changes
CONTRIBUTING.md Outdated
This project comes with a sample `.env` file (`.env.sample`) that you can copy and modify. At the very least, you
will need to include the `PINECONE_API_KEY` variable in your `.env` file for the tests to run locally.
At a minimum, you will need to declare a `PINECONE_API_KEY` variable in your environment in order to interact with Pinecone services, and
run the integration tests locally. If `PINECONE_API_KEY` is available in you environment, the `Client` struct can be created with `NewClient`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"you" should be "your" here on ln 14 :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@aulorbe aulorbe self-requested a review August 5, 2024 23:08
aulorbe
aulorbe approved these changes Aug 5, 2024
View reviewed changes
Copy link
Contributor

@aulorbe aulorbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just 1 spelling nit

@austin-denoble austin-denoble merged commit f63e3ad into main Aug 6, 2024
3 checks passed
@austin-denoble austin-denoble deleted the adenoble/remove-env-example branch August 6, 2024 05:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aulorbe aulorbe aulorbe approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@austin-denoble @aulorbe