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

Replace all text references of Github to GitHub #16

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

AndreaGriffiths11
Copy link
Contributor

@AndreaGriffiths11 AndreaGriffiths11 commented Sep 20, 2024

Replace all instances of "Github" with "GitHub" across multiple files. Disculpa lo cansona!

  • README.md
    • Replace all instances of "Github" with "GitHub".
  • CONTRIBUITING.md
    • Replace all instances of "Github" with "GitHub".
  • SECURITY.md
    • Replace "Github" with "GitHub".
  • package.json
    • Replace "Github" with "GitHub" in the description and keywords.
  • .github/dependabot.yml
    • Replace "Github" with "GitHub" in the comments.
  • .github/FUNDING.yml
    • Replace "Github" with "GitHub" in the comments.
  • .github/PULL_REQUEST_TEMPLATE.md
    • Replace "Github" with "GitHub" in the URLs.

Summary by CodeRabbit

  • Chores
    • Updated URLs in the pull request template for contribution guidelines and code of conduct.
    • Adjusted the dependabot.yml schedule formatting for daily updates.
    • Minor formatting changes in CONTRIBUTING.md and SECURITY.md.
    • Corrected capitalization of "GitHub" throughout README.md and package.json for consistency.

Replace all instances of "Github" with "GitHub" across multiple files.

* **README.md**
  - Replace all instances of "Github" with "GitHub".
* **CONTRIBUITING.md**
  - Replace all instances of "Github" with "GitHub".
* **SECURITY.md**
  - Replace "Github" with "GitHub".
* **package.json**
  - Replace "Github" with "GitHub" in the description and keywords.
* **.github/dependabot.yml**
  - Replace "Github" with "GitHub" in the comments.
* **.github/FUNDING.yml**
  - Replace "Github" with "GitHub" in the comments.
* **.github/PULL_REQUEST_TEMPLATE.md**
  - Replace "Github" with "GitHub" in the URLs.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/xavidop/genkitx-github?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link
Contributor

coderabbitai bot commented Sep 20, 2024

Walkthrough

The pull request includes a series of minor textual updates across multiple documentation files and configuration settings. Key changes involve correcting the capitalization of "GitHub," updating URLs in the pull request template, and ensuring consistent formatting, such as adding newline characters. The functional content of the files remains unchanged, focusing primarily on improving clarity and adherence to naming conventions.

Changes

File(s) Change Summary
.github/PULL_REQUEST_TEMPLATE.md Updated URLs for contribution guidelines and code of conduct, correcting "genkitx-github" to "genkitx-GitHub."
.github/dependabot.yml Modified the schedule attribute's formatting in the updates section, maintaining a daily interval.
CONTRIBUTING.md Added a newline character at the end of the document.
README.md Corrected capitalization of "GitHub" throughout the document for consistency.
SECURITY.md Added a newline character at the end of the file regarding vulnerability disclosure.
package.json Corrected "Github" to "GitHub" in the description field.

Possibly related PRs

  • feat: add embedders models #5: The changes in the README.md file regarding the supported models are related to the main PR's updates to the documentation, specifically in terms of ensuring consistent branding and terminology for "GitHub."

🐰 In fields of green, we hop with glee,
Our docs now shine, as bright as can be!
With "GitHub" fixed, and guidelines clear,
A joyful change, let’s all give a cheer!
So let’s contribute, with hearts so light,
Together we’ll code, from morning till night! 🌼


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 61133b6 and 89e27f5.

Files selected for processing (6)
  • .github/PULL_REQUEST_TEMPLATE.md (2 hunks)
  • .github/dependabot.yml (1 hunks)
  • CONTRIBUITING.md (1 hunks)
  • README.md (6 hunks)
  • SECURITY.md (1 hunks)
  • package.json (1 hunks)
Files skipped from review due to trivial changes (4)
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/dependabot.yml
  • CONTRIBUITING.md
  • package.json
Additional context used
LanguageTool
README.md

[grammar] ~27-~27: Did you mean “using”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...om/xavidop). This Genkit plugin allows to use GitHub models through their official AP...

(ALLOW_TO)

Markdownlint
SECURITY.md

9-9: null
Bare URL used

(MD034, no-bare-urls)


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>, please review it.
    -- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @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.
    -- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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
Owner

@xavidop xavidop left a comment

Choose a reason for hiding this comment

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

2 small changes requested! thanks for the help!!!

@@ -9,12 +9,12 @@ _Before you submit a pull request, please make sure you have read and understood

**I have checked the following:**

- [ ] I have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-github/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-github/blob/main/CODE_OF_CONDUCT.md);
- [ ] I have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-GitHub/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-GitHub/blob/main/CODE_OF_CONDUCT.md);
Copy link
Owner

Choose a reason for hiding this comment

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

this URL does not need to be changed

@@ -1,4 +1,4 @@
_Before you submit a pull request, please make sure you have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-github/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-github/blob/main/CODE_OF_CONDUCT.md)._
_Before you submit a pull request, please make sure you have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-GitHub/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-GitHub/blob/main/CODE_OF_CONDUCT.md)._
Copy link
Owner

Choose a reason for hiding this comment

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

this URL does not need to be changed

@xavidop xavidop merged commit f14ec65 into xavidop:main Sep 20, 2024
5 checks passed
Copy link

🎉 This PR is included in version 1.4.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@coderabbitai coderabbitai bot mentioned this pull request Nov 7, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants