chore: minor changes, documentation updates

[lotyp]

Summary by CodeRabbit

• Documentation

  • Updated security reporting guidelines to direct users to use GitHub Security Advisories for confidential reporting.
  • Revised contact options in documentation, replacing email with GitHub discussions and Discord community links.
  • Enhanced clarity in security vulnerability reporting instructions, including steps for using GitHub Advisories and direct contact protocols for sensitive information.

• Chores

  • Adjusted editor configurations for YAML files and Makefiles to improve development consistency.

[coderabbitai]

Walkthrough

The recent updates focus on enhancing security and communication protocols across various project files. Changes include refining indentation styles, updating contact methods, and improving guidelines for reporting security vulnerabilities. These adjustments aim to streamline development workflows and bolster security measures.

Changes

File Path	Change Summary
.editorconfig, Makefile	Adjusted indentation settings and redirected output for linting commands.
.../ISSUE_TEMPLATE/...	Updated templates for security reporting and contact links, emphasizing private reporting through GitHub Advisories and community engagement via GitHub and Discord.
.github/SECURITY.md	Refined instructions for confidential vulnerability reporting and clarified the handling of third-party bug bounty reports.
README.md	Removed a <br> tag from a <div> block in the HTML code.

🐰✨
O hark! A change, a tweak, a twist,
In files and lines, our digital mist.
Tabs to spaces, links renew,
Safe whispers of secrets, kept from view.
Hop with joy, for code we trust,
In bytes we bond, in updates, a must! 🌟
🐰💻

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 355eae1 and 5954b02.

Files selected for processing (6)

• .editorconfig (1 hunks)
• .github/ISSUE_TEMPLATE/5-security-report.yml (2 hunks)
• .github/ISSUE_TEMPLATE/config.yml (1 hunks)
• .github/SECURITY.md (1 hunks)
• Makefile (1 hunks)
• README.md (1 hunks)

Additional Context Used

LanguageTool (58)

.github/SECURITY.md (2)

Near line 3: You might be missing the article “the” here.
Context: ...rity Policy Thank you for helping keep project and its users safe. We greatly apprecia...

---

Near line 22: For conciseness, consider replacing this expression with an adverb.
Context: ... ## ❌ Third-Party Bug Bounty Platforms At this moment, we DO NOT accept reports from third-pa...

README.md (56)

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

Near line 303: 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 380: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...

---

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

---

Near line 398: 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 405: The official name of this software platform is spelled with a capital “H”.
Context: ...indly check our contribution guidelines.
## 🌐 Social L...

---

Near line 412: 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 418: Possible spelling mistake found.
Context: ...or Information Created in 2023 by lotyp @ [wayofdev]...

---

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

---

Near line 426: 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 426: Possible spelling mistake found.
Context: ...fference-github-actions-11kd) * cycle/gh-actions —...

---

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

---

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

---

Near line 428: Unpaired symbol: ‘[’ seems to be missing
Context: ...ycle) organization. * ergebnis/.github — ...

---

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

---

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

Additional comments not posted (12)

.editorconfig (2)

14-14: Ensure the indentation size for YAML files is consistent with your project's standards.

---

17-18: Setting the indent style to tab for Makefiles is a good practice for consistency across environments.

.github/ISSUE_TEMPLATE/config.yml (1)

6-13: The updated contact links for GitHub discussions and Discord are well implemented. This should enhance community engagement.

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

4-4: Clarifying the use of GitHub Security Advisories in the description enhances the privacy of security reporting.

---

14-24: Instructions on not reporting security vulnerabilities publicly and using GitHub Advisories are clear and enhance security practices.

---

27-31: Providing a field for the GitHub Advisory URL is a thoughtful addition, allowing for better tracking of security issues.

.github/SECURITY.md (3)

9-9: Updating the introduction to emphasize the seriousness of security bugs sets the right tone for the security policy.

---

13-18: The detailed steps for reporting vulnerabilities through GitHub Security Advisories and direct contact are well structured and enhance the confidentiality of the process.

---

21-23: Explicitly stating the exclusion of third-party bug bounty platforms clarifies the accepted channels for reporting vulnerabilities.

Makefile (2)

80-80: Redirecting the output of YAML linting to a log file using tee is a good practice for maintaining logs of the linting process.

---

84-84: Similarly, redirecting the output of GitHub Actions linting ensures that logs are preserved, which can be helpful for debugging and verification.

README.md (1)

Line range hint 1-1: Removing the <br> tag within the <div> block simplifies the HTML structure and improves the visual presentation of the document.

---

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.