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.

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

OpenAI-Key-Readme #84

Merged
merged 2 commits into from
May 5, 2024
Merged

OpenAI-Key-Readme #84

merged 2 commits into from
May 5, 2024

Conversation

swilly22
Copy link
Contributor

@swilly22 swilly22 commented May 1, 2024

Resolves: #83

Summary by CodeRabbit

  • Documentation
    • Enhanced README.md with instructions for setting the OpenAI API key, providing clear guidance on configuring API access.

@swilly22 swilly22 added the documentation Improvements or additions to documentation label May 1, 2024
@swilly22 swilly22 requested a review from gkorland May 1, 2024 05:53
Copy link

vercel bot commented May 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
code-graph ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 5, 2024 10:46am

Copy link
Contributor

coderabbitai bot commented May 1, 2024

Walkthrough

The change focuses on updating the README.md file to include instructions for setting the OpenAI API key, ensuring users can easily configure API access.

Changes

File Change Summary
README.md Added instructions for setting the OpenAI API key.

Possibly related issues

🐇📜✨
A hop, a skip, a code deploy,
In README.md, a new key toy.
Set it right, no need to guess,
With clear instructions, no more stress.
🌟🐾


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

README.md Outdated
Comment on lines 21 to 25
Set your OpenAI key
```
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure proper formatting of the fenced code block.

+ 
Set your OpenAI key

23~
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
24~

+ 

Add blank lines around the fenced code block and specify the language as bash for better readability and syntax highlighting.

@gkorland gkorland merged commit c7e18ee into main May 5, 2024
3 of 4 checks passed
@gkorland gkorland deleted the swilly22-patch-1 branch May 5, 2024 10:45
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 13976d0 and c5b3e1a.
Files selected for processing (1)
  • README.md (1 hunks)

Comment on lines +21 to +26
Set your OpenAI key

```
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure proper formatting of the fenced code block for setting the OpenAI API key.

- Set your OpenAI key
- ```
- export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
- ```
+ Set your OpenAI key:
+ ```bash
+ export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
+ ```

Add blank lines around the fenced code block and specify the language as bash for better readability and syntax highlighting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend README with OpenAI KEY configuration
2 participants