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

🎨 Github Integration Forms #437

Merged
merged 1 commit into from
May 20, 2024
Merged

🎨 Github Integration Forms #437

merged 1 commit into from
May 20, 2024

Conversation

rflihxyz
Copy link
Contributor

No description provided.

Copy link

vercel bot commented May 20, 2024

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

Name Status Preview Comments Updated (UTC)
panora-client-ts 🔄 Building (Inspect) Visit Preview 💬 Add feedback May 20, 2024 1:48am

Copy link

changeset-bot bot commented May 20, 2024

⚠️ No Changeset found

Latest commit: 84b0b36

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 20, 2024

Walkthrough

The changes in the .github/ISSUE_TEMPLATE/new-integration-request.md file simplify the structure of the integration request template. The new format focuses on user experience by including a markdown message, an input field for contact details, a dropdown for verticals, and a textarea for platforms, while removing the previous sections on tools, objects, and data interaction.

Changes

File Path Change Summary
.github/ISSUE_TEMPLATE/new-integration-request.md Simplified template structure: added markdown message, contact details input, verticals dropdown, and platforms textarea; removed sections on tools, objects, and data interaction

In the meadow where codes align,
A rabbit hops with changes fine.
Templates now more clear and bright,
Simplified for user delight.
Contact fields and dropdowns new,
Platforms textarea, just for you. 🐇


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.

@rflihxyz rflihxyz merged commit e33ebea into main May 20, 2024
12 of 15 checks passed
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: 3

Out of diff range and nitpick comments (2)
.github/ISSUE_TEMPLATE/new-integration-request.md (2)

11-11: Consider revising the gratitude message for a more professional tone.


37-37: Ensure the file ends with a newline character.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 159ccc4 and 84b0b36.
Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/new-integration-request.md (1 hunks)
Additional Context Used
LanguageTool (1)
.github/ISSUE_TEMPLATE/new-integration-request.md (1)

Near line 16: Consider using a more formal alternative.
Context: ...can we get in touch with you if we need more info? placeholder: ex. email@example.c...

id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider using a more formal tone in the contact details description.

- How can we get in touch with you if we need more info?
+ How can we contact you for further information?

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
description: How can we get in touch with you if we need more info?
description: How can we contact you for further information?

attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid using example emails directly in the placeholder. Use a more generic placeholder.

- placeholder: ex. email@example.com
+ placeholder: your-email@example.com

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
placeholder: ex. email@example.com
placeholder: your-email@example.com

id: platforms
attributes:
label: Platforms
description: Which specific platforms would you integrate with? (ex: Salesforce, Hubspot, Jira...)
Copy link
Contributor

Choose a reason for hiding this comment

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

Specify platforms more clearly to avoid ambiguity.

- Which specific platforms would you integrate with? (ex: Salesforce, Hubspot, Jira...)
+ Please specify the platforms you wish to integrate with, e.g., Salesforce, Hubspot, Jira.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
description: Which specific platforms would you integrate with? (ex: Salesforce, Hubspot, Jira...)
description: Please specify the platforms you wish to integrate with, e.g., Salesforce, Hubspot, Jira.

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

Successfully merging this pull request may close these issues.

1 participant