docs: issue templates

[lotyp]

Summary by CodeRabbit

• New Features

  • Introduced a series of GitHub issue templates for bug reports, feature requests, failing tests, documentation issues, and security reports to streamline user submissions and enhance project management.
  • Enabled blank issue submissions and added contact links for direct communication with developers.
  • Updated README files across various components to improve information accessibility, including links to licenses, commit history, and Conventional Commits.

• Documentation

  • Enhanced documentation with the addition of guidelines, links to project resources, and community discussions in new issue templates.

[coderabbitai]

Walkthrough

The recent updates introduce a series of GitHub issue templates aimed at streamlining the reporting process for bugs, feature requests, failing tests, documentation issues, and security concerns. Additionally, there are enhancements to the README files, including updated links and the introduction of Conventional Commits badges, improving project transparency and contribution guidelines.

Changes

Files	Changes
.github/ISSUE_TEMPLATE/...	Introduced templates for bug reports, feature requests, failing tests, docs issues, and security reports.
.github/ISSUE_TEMPLATE/config.yml	Enabled blank issues and provided contact links.
README.md and actions/composer/.../README.md	Updated URLs, added Conventional Commits link and badge, and modified action names.

🐰✨
In the garden of code, where issues bloom,
Templates spring up, giving clarity room.
A rabbit hops by, leaving marks of delight,
In READMEs and docs, improving the sight.
Celebrate we now, with commits so bright! 🌟
🐰

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 706a892 and 0046b4c.

Files selected for processing (8)

• .github/ISSUE_TEMPLATE/1-bug-report.yml (1 hunks)
• .github/ISSUE_TEMPLATE/2-feature-request.yml (1 hunks)
• .github/ISSUE_TEMPLATE/3-failing-test.yml (1 hunks)
• .github/ISSUE_TEMPLATE/4-docs-bug-report.yml (1 hunks)
• .github/ISSUE_TEMPLATE/5-security-report.yml (1 hunks)
• .github/ISSUE_TEMPLATE/config.yml (1 hunks)
• README.md (2 hunks)
• actions/composer/get-cache-directory/README.md (1 hunks)

Files skipped from review due to trivial changes (2)

• .github/ISSUE_TEMPLATE/2-feature-request.yml
• .github/ISSUE_TEMPLATE/3-failing-test.yml

Additional Context Used

LanguageTool (58)

README.md (54)

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

---

Near line 27: 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 27: Possible spelling mistake found.
Context: ...ures standardized operations across all Wayofdev repositories.
## 📋 Table of Con...

---

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

---

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

---

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

---

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

---

Near line 69: You might be missing the article “an” here.
Context: ... the specified branch and exports it as env variable. | | [composer/install](./ac...

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

Near line 88: 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 90: 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 90: Possible spelling mistake found.
Context: ...ore information on how to configure the labeler, see: https://github.com/actions/labele...

---

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

---

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

---

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

---

Near line 147: 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 219: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/next-starter-tpl](https://github.com/w...

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

Near line 389: 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 395: Possible spelling mistake found.
Context: ...you for considering contributing to the wayofdev community! We are open to all kinds of ...

---

Near line 395: 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 - 🐛 Report an...

---

Near line 402: The official name of this software platform is spelled with a capital “H”.
Context: ...indly check our contribution guidelines.
## 🌐 Social L...

---

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 415: Possible spelling mistake found.
Context: ...or Information Created in 2023 by lotyp @ [wayofd...

---

Near line 415: Possible spelling mistake found.
Context: ...lotyp @ wayofdev
##...

---

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

---

Near line 423: The official name of this software platform is spelled with a capital “H”.
Context: ...ence-github-actions-11kd) * ergebnis/.github —...

---

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

---

Near line 425: Unpaired symbol: ‘[’ seems to be missing
Context: ...anization. * [skills/reusable-workflows](https://github.com/skills/reusable-work...

actions/composer/get-cache-directory/README.md (4)

Near line 28: The official name of this software platform is spelled with a capital “H”.
Context: ...reate a new workflow file, for example, .github/workflows/integrate.yml, and add the f...

---

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

---

Near line 70: Loose punctuation mark.
Context: ...cture ### Inputs - working-directory, optional: The working directory to use....

---

Near line 70: Unpaired symbol: ‘"’ seems to be missing
Context: ...e working directory to use. Defaults to ".". ### Outputs none ### Side Effect...

Additional comments not posted (7)

.github/ISSUE_TEMPLATE/config.yml (2)

3-3: Enabling blank issues allows for greater flexibility in issue reporting.

---

5-8: Ensure the email provided is monitored, as it's publicly visible and could receive high volumes of emails.

.github/ISSUE_TEMPLATE/5-security-report.yml (1)

3-6: The template is well-structured to capture critical security issue details.

actions/composer/get-cache-directory/README.md (1)

12-13: The addition of the Conventional Commits badge and link provides clear guidance on commit standards.

.github/ISSUE_TEMPLATE/4-docs-bug-report.yml (1)

3-6: The template effectively guides the user to provide comprehensive details about documentation issues.

.github/ISSUE_TEMPLATE/1-bug-report.yml (1)

3-6: The template is well-designed to capture essential details for bug reporting.

README.md (1)

14-16: Updates to the URLs for licenses and commits since the latest release help keep the repository information current and accessible.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

Actionable comments posted: 3