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

ci: update github files #385

Merged
merged 6 commits into from
May 29, 2024
Merged

ci: update github files #385

merged 6 commits into from
May 29, 2024

Conversation

lotyp
Copy link
Member

@lotyp lotyp commented May 29, 2024

Summary by CodeRabbit

  • New Features

    • Introduced structured templates for reporting bugs, feature requests, failing tests, documentation issues, and security vulnerabilities.
    • Added a Contributor Covenant Code of Conduct to outline community behavior standards.
    • Implemented GitHub funding information for the organization.
  • Chores

    • Configured commit message linting and commit message templates to ensure consistent and clear commit messages.
    • Updated CODEOWNERS to assign ownership and reference GitHub documentation.
    • Added issue configuration settings to enable blank issues and provide community contact links.

@github-actions github-actions bot added type: enhancement For features and enhancements (feat) type: documentation labels May 29, 2024
Copy link

coderabbitai bot commented May 29, 2024

Warning

Review Failed

The pull request is closed.

Walkthrough

The recent updates focus on improving the project's GitHub repository management and contributor experience. New configurations for commit linting, Commitizen, and issue templates have been added. Additionally, a Code of Conduct, funding information, and a CODEOWNERS file have been introduced. These changes aim to enhance the project's structure, streamline contributions, and ensure a welcoming community environment.

Changes

Files/Paths Change Summary
.github/.commitlint.config.mjs Added commitlint configuration with custom rules and ignore patterns.
.github/.cz.config.js Introduced Commitizen configuration for structured commit messages.
.github/CODEOWNERS Added ownership assignments and a reference link to GitHub documentation.
.github/CODE_OF_CONDUCT.md Introduced the Contributor Covenant Code of Conduct.
.github/FUNDING.yml Added funding information for the wayofdev organization.
.github/ISSUE_TEMPLATE/... Added various issue templates for bug reports, feature requests, failing tests, docs bugs, and security reports.
.github/ISSUE_TEMPLATE/config.yml Added configuration settings for GitHub issues, enabling blank issues and providing contact links.

Poem

In the code's garden, changes bloom,
New templates guide us, dispelling gloom.
Commit messages now pristine and clear,
With Commitizen's help, structure is near.
A Code of Conduct, kind and fair,
Ensures our community's care.
🐇✨


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.
    • @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 as 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.

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.

Copy link

codecov bot commented May 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.36%. Comparing base (70de737) to head (c043be8).

Current head c043be8 differs from pull request most recent head bb77426

Please upload reports for the commit bb77426 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #385   +/-   ##
==========================================
  Coverage      48.36%   48.36%           
  Complexity        49       49           
==========================================
  Files             23       23           
  Lines            122      122           
==========================================
  Hits              59       59           
  Misses            63       63           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@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: 4

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 70de737 and c043be8.
Files selected for processing (12)
  • .github/.commitlint.config.mjs (1 hunks)
  • .github/.cz.config.js (1 hunks)
  • .github/CODEOWNERS (1 hunks)
  • .github/CODE_OF_CONDUCT.md (1 hunks)
  • .github/FUNDING.yml (1 hunks)
  • .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)
  • .github/SECURITY.md (1 hunks)
Files not summarized due to errors (1)
  • .github/SECURITY.md: Error: Server error. Please try again later.
Files skipped from review due to trivial changes (8)
  • .github/.commitlint.config.mjs
  • .github/CODEOWNERS
  • .github/FUNDING.yml
  • .github/ISSUE_TEMPLATE/1-bug-report.yml
  • .github/ISSUE_TEMPLATE/2-feature-request.yml
  • .github/ISSUE_TEMPLATE/3-failing-test.yml
  • .github/ISSUE_TEMPLATE/5-security-report.yml
  • .github/ISSUE_TEMPLATE/config.yml
Additional Context Used
LanguageTool (4)
.github/CODE_OF_CONDUCT.md (2)

Near line 32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...
Rule ID: COMMENT_REMARK


Near line 120: You might be missing the article “the” here.
Context: ...org/version/2/0/code_of_conduct.html>. Community Impact Guidelines were inspired by [Moz...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_THE

.github/SECURITY.md (2)

Near line 12: A punctuation mark might be missing here.
Context: ... | |---------|--------------------| | 2.x | ✅ | Please...
Rule ID: AI_EN_LECTOR_MISSING_PUNCTUATION


Near line 34: 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...
Rule ID: AT_THE_MOMENT

Biome (2)
.github/.cz.config.js (2)

57-57: Use Number.Infinity instead of the equivalent global.


58-58: Use Number.Infinity instead of the equivalent global.

Additional comments not posted (2)
.github/SECURITY.md (2)

1-16: The introduction and supported versions sections are clear and well-written.


19-31: The instructions for reporting vulnerabilities are comprehensive and provide multiple secure channels, enhancing the security posture.

Comment on lines +33 to +35
## ❌ Third-Party Bug Bounty Platforms

At this moment, we DO NOT accept reports from third-party bug bounty platforms to minimize risk. All vulnerability reports should come through the specified channels above.
Copy link

Choose a reason for hiding this comment

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

Consider replacing "At this moment" with "Currently" for conciseness.

- At this moment, we DO NOT accept reports from third-party bug bounty platforms to minimize risk.
+ Currently, we DO NOT accept reports from third-party bug bounty platforms to minimize risk.

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
## ❌ Third-Party Bug Bounty Platforms
At this moment, we DO NOT accept reports from third-party bug bounty platforms to minimize risk. All vulnerability reports should come through the specified channels above.
## ❌ Third-Party Bug Bounty Platforms
Currently, we DO NOT accept reports from third-party bug bounty platforms to minimize risk. All vulnerability reports should come through the specified channels above.

- type: textarea
id: media-prove
attributes:
label: Media prove
Copy link

Choose a reason for hiding this comment

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

Correct the label from "Media prove" to "Media proof" to enhance clarity.

- label: Media prove
+ label: Media proof

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
label: Media prove
label: Media proof

Comment on lines +57 to +58
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
Copy link

Choose a reason for hiding this comment

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

Use Number.Infinity instead of Infinity for better clarity and consistency in JavaScript.

- maxHeaderLength: Infinity,
- maxSubjectLength: Infinity,
+ maxHeaderLength: Number.Infinity,
+ maxSubjectLength: Number.Infinity,

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
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
maxHeaderLength: Number.Infinity,
maxSubjectLength: Number.Infinity,

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Copy link

Choose a reason for hiding this comment

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

Add "the" before "Mozilla's code of conduct enforcement ladder" for grammatical correctness.

- Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+ Community Impact Guidelines were inspired by [the Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

Committable suggestion was skipped due low confidence.

lotyp added 5 commits May 29, 2024 12:01
ci: update Makefile with latest commands

ci(docker-compose): add healthcheck for pgsql database

ci(composer-require-checker): lint project files
@github-actions github-actions bot added the type: maintenance For maintenance, refactor and testing (perf, chore, style, revert, refactor, test, build, ci) label May 29, 2024
@lotyp lotyp merged commit 4228153 into develop May 29, 2024
6 checks passed
@lotyp lotyp deleted the feat/laravel-11 branch May 29, 2024 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation type: enhancement For features and enhancements (feat) type: maintenance For maintenance, refactor and testing (perf, chore, style, revert, refactor, test, build, ci)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant