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

docs: contribute options as links #74

Merged
merged 1 commit into from
Apr 26, 2024
Merged

docs: contribute options as links #74

merged 1 commit into from
Apr 26, 2024

Conversation

lotyp
Copy link
Member

@lotyp lotyp commented Apr 26, 2024

Summary by CodeRabbit

  • Documentation
    • Updated contribution links in the README to direct users to specific templates for feature suggestions, issue reporting, and documentation improvements.

@github-actions github-actions bot added the type: enhancement For features and enhancements (feat) label Apr 26, 2024
@lotyp lotyp merged commit 6b57dc0 into master Apr 26, 2024
4 checks passed
@lotyp lotyp deleted the feat/refactor branch April 26, 2024 15:49
Copy link

coderabbitai bot commented Apr 26, 2024

Walkthrough

The project's README.md has been updated to include direct links for community contributions. These changes streamline the process for users to suggest features, report issues, and improve documentation by providing specific templates on GitHub.

Changes

File Change Summary
README.md Updated contribution links to direct users to specific GitHub templates for feature suggestions, issue reporting, and documentation improvements.

🐇💬
In the garden of code, where ideas bloom,
A rabbit hopped by, under the moon.
With a click and a tap, new paths were laid,
For bugs to be caught, and features displayed.
Hoppity hop, on soft digital paws,
To improve, to enhance, for a noble cause! 🌟📜


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 121c30a and 4a7531a.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (52)
README.md (52)

Near line 24: Possible spelling mistake found.
Context: ...ion), specifically designed for use in wayofdev projects....


Near line 26: Opting for a less wordy alternative here can improve the clarity of your writing.
Context: ...n into multiple projects. This approach not only reduces the need to rewrite code but also ensures standardized operations across all Wayo...


Near line 26: Possible spelling mistake found.
Context: ...ures standardized operations across all Wayofdev repositories.
## 📋 Table of Con...


Near line 64: Possible typo: you repeated a whitespace
Context: ...ructions on how to use it. | Action | Description ...


Near line 64: Possible typo: you repeated a whitespace
Context: ... | Description | |-------------------------------------...


Near line 66: Possible typo: you repeated a whitespace
Context: ...ry path and exports it as env variable. | | [composer/get-root-version](./acti...


Near line 67: Possible typo: you repeated a whitespace
Context: ...ons/composer/get-root-version/README.md) | determines the Composer root version b...


Near line 68: Possible typo: you repeated a whitespace
Context: ...`](./actions/composer/install/README.md) | Installs dependencies with Composer ba...


Near line 68: Possible typo: you repeated a whitespace
Context: ...ased on the specified dependency level. | | [phive/install](./actions/phive/in...


Near line 69: Possible spelling mistake found.
Context: ...ndency level. | | [phive/install](./actions/phive/install/READM...


Near line 69: Possible typo: you repeated a whitespace
Context: ...all`](./actions/phive/install/README.md) | Install dependencies with [Phive](http...


Near line 69: Possible spelling mistake found.
Context: ... | Install dependencies with Phive. ...


Near line 69: Possible typo: you repeated a whitespace
Context: ...ndencies with Phive. | | [playwright/install](./actions/pla...


Near line 70: Possible typo: you repeated a whitespace
Context: ...(./actions/playwright/install/README.md) | Installs [Playwright](https://playwrig...


Near line 70: Possible typo: you repeated a whitespace
Context: ...ight.dev/) along with its dependencies. | | [pnpm/install](./actions/pnpm/inst...


Near line 71: Possible spelling mistake found.
Context: ...ependencies. | | [pnpm/install](./actions/pnpm/install/README...


Near line 71: Possible typo: you repeated a whitespace
Context: ...tall`](./actions/pnpm/install/README.md) | Installs mono-repository dependencies ...


Near line 71: Possible spelling mistake found.
Context: ...lls mono-repository dependencies using PNPM. ...


Near line 71: Possible typo: you repeated a whitespace
Context: ...dencies using PNPM. | | [s3/cache](./actions/s3/cache/READ...


Near line 72: Possible typo: you repeated a whitespace
Context: ...s3/cache`](./actions/s3/cache/README.md) | Cache artifacts, or restore them using...


Near line 72: Possible typo: you repeated a whitespace
Context: ...he artifacts, or restore them using S3. |
## 🔧 Workflows Read more abou...


Near line 86: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ests and make it easier to identify the type of changes included. To use this workflow, set up...


Near line 88: The official name of this software platform is spelled with a capital “H”.
Context: ...cluded. To use this workflow, set up a .github/labeler.yml file with your configurati...


Near line 88: Possible spelling mistake found.
Context: ...ore information on how to configure the labeler, see: <https://github.com/actions/label...


Near line 140: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...


Near line 146: Possible spelling mistake found.
Context: ...erges releases. This workflow utilizes [peter-evans/enable-pull-request-automerge](https://...


Near line 146: Possible spelling mistake found.
Context: ...es. This workflow utilizes [peter-evans/enable-pull-request-automerge](https://github.com/peter-evans/enable-...


Near line 146: Possible spelling mistake found.
Context: ...uto-merge releases that are created by [googleapis/release-please](https://github.com/goog...


Near line 182: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...


Near line 188: Possible spelling mistake found.
Context: ...his workflow creates a release based on changesets. This workflow utilizes [changesets/act...


Near line 188: Possible spelling mistake found.
Context: ... on changesets. This workflow utilizes [changesets/action](https://github.com/changesets/a...


Near line 188: Possible spelling mistake found.
Context: ...ts/action) to create a release based on changesets. Here is an example of how to use this...


Near line 220: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/next-starter-tpl](https://github.com/w...


Near line 232: Possible spelling mistake found.
Context: ... repositories, using this workflow: - [wayofdev/docker-node](https://github.com/wayofde...


Near line 293: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/docker-node](https://github.com/wayofd...


Near line 301: Possible spelling mistake found.
Context: ...ram.yml:` This workflow leverages the [codesee-io/codesee-action](https://github.com/Code...


Near line 301: Possible spelling mistake found.
Context: ...This workflow leverages the [codesee-io/codesee-action](https://github.com/Codesee-io/codesee-...


Near line 302: Possible spelling mistake found.
Context: ...ebase whenever a pull request is made. CodeSee is an open-source tool that helps visua...


Near line 341: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...


Near line 349: Possible spelling mistake found.
Context: ... shellcheck.yml: This workflow uses [redhat-plumbers-in-action/differential-shellcheck](https://github...


Near line 349: Possible spelling mistake found.
Context: ...orkflow uses [redhat-plumbers-in-action/differential-shellcheck](https://github.com/redhat-plumbers-in-...


Near line 381: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...


Near line 387: The official name of this software platform is spelled with a capital “H”.
Context: ...icy This project has a security policy.
## 🙌 Want to Cont...


Near line 393: Possible spelling mistake found.
Context: ...you for considering contributing to the wayofdev community! We are open to all kinds of ...


Near line 393: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...are open to all kinds of contributions. If you want to: - 🤔 [Suggest a feature](https://gith...


Near line 400: The official name of this software platform is spelled with a capital “H”.
Context: ...indly check our contribution guidelines. [![Conventional Comm...


Near line 409: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...low?screen_name=wlotyp). - Discord: Join our community on [Discord](https://disc...


Near line 423: This sentence does not start with an uppercase letter.
Context: ...the-difference-github-actions-11kd) - [cycle/gh-actions](https://github.com/cycle/gh...


Near line 423: Possible spelling mistake found.
Context: ...fference-github-actions-11kd) - cycle/gh-actions —...


Near line 425: This sentence does not start with an uppercase letter.
Context: ...s://github.com/cycle) organization. - [ergebnis/.github](https://github.com/ergebnis/.g...


Near line 425: The official name of this software platform is spelled with a capital “H”.
Context: ....com/cycle) organization. - ergebnis/.github —...


Near line 427: This sentence does not start with an uppercase letter.
Context: .../github.com/ergebnis) organization. - [skills/reusable-workflows](https://github.com/...

Additional comments not posted (1)
README.md (1)

395-397: The conversion of contribution options into clickable links is correctly implemented and aligns with the PR's objectives to enhance user experience.


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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement For features and enhancements (feat)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant