Skip to content

Format all docs with deno fmt#86

Merged
5ouma merged 1 commit intomainfrom
docs-fmt
Oct 13, 2024
Merged

Format all docs with deno fmt#86
5ouma merged 1 commit intomainfrom
docs-fmt

Conversation

@5ouma
Copy link
Owner

@5ouma 5ouma commented Oct 13, 2024

⚠️ Issue

close #


🔄 Type of the Change

  • 🎉 New Feature
  • 🧰 Bug
  • 🛡️ Security
  • 📖 Documentation
  • 🏎️ Performance
  • 🧹 Refactoring
  • 🧪 Testing
  • 🔧 Maintenance
  • 🎽 CI
  • ⛓️ Dependencies
  • 🧠 Meta

✏️ Description

It doesn't conflict with the markdownlint.

@5ouma
docs(markdown): Format all docs with deno fmt
47b0789 
It doesn't conflict with the markdownlint.
@coderabbitai
Copy link

coderabbitai bot commented Oct 13, 2024 •
edited
Loading

Walkthrough

The pull request includes various formatting and readability improvements across multiple documentation files in the repository. Changes involve adjustments to line breaks, text alignment, and punctuation to enhance clarity without altering the underlying content. The deno.json file has a significant modification with the removal of the fmt property, while other files maintain their core content but improve presentation.

Changes

File Change Summary
.github/CODE_OF_CONDUCT.md Text formatting adjustments, removal of line breaks, restructured phrases for clarity.
.github/CONTRIBUTING.md Formatting and text flow improvements, consolidation of sentences, added note on Code of Conduct.
.github/PULL_REQUEST_TEMPLATE.md Changed agreement checkbox format from single line to multi-line for better readability.
.github/SECURITY.md Modified formatting of reporting instructions from single line to multi-line for improved clarity.
README.md Formatting adjustments for readability, restructuring of bullet points, and minor punctuation fixes.
deno.json Removed fmt property; other properties remain unchanged.

Suggested labels

🎉 New Feature

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 21cb5a6 and 47b0789.

📒 Files selected for processing (6)
  • .github/CODE_OF_CONDUCT.md (5 hunks)
  • .github/CONTRIBUTING.md (2 hunks)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
  • .github/SECURITY.md (1 hunks)
  • README.md (3 hunks)
  • deno.json (0 hunks)
💤 Files with no reviewable changes (1)
  • deno.json
✅ Files skipped from review due to trivial changes (2)
  • .github/CONTRIBUTING.md
  • .github/PULL_REQUEST_TEMPLATE.md
🧰 Additional context used
🪛 LanguageTool
.github/CODE_OF_CONDUCT.md

[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind - Trolling, insulting or derogatory comments, and personal or political attacks - Pu...

(COMMENT_REMARK)

[uncategorized] ~62-~62: The preposition ‘in’ seems more likely in this position.
Context: ...ity leaders responsible for enforcement at any ways @5ouma have. All complaints wi...

(AI_HYDRA_LEO_REPLACE_AT_IN)

.github/SECURITY.md

[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...# 🛡️ Reporting a Vulnerability If you find any issues of security, please report o...

(FIND_ENCOUNTER)

README.md

[grammar] ~31-~31: Did you mean “be redirected”?
Context: ...`) If you access from browsers, you'll redirected to the GitHub page, not a raw file. Fo...

(WILL_BASED_ON)

[style] ~35-~35: Consider a more expressive alternative.
Context: ...s to the different branches or tags. To do this, simply add the ref name to the su...

(DO_ACHIEVE)

[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...do this, simply add the ref name to the sub-directory. (i.e. `curl https://example.com/ref | ...

(EN_COMPOUNDS_SUB_DIRECTORY)

[style] ~171-~171: Using many exclamation marks might seem excessive (in this case: 13 exclamation marks for a text that’s 3253 characters long)
Context: ...ng I happily welcome your contributions! Before you contribute, I would recommen...

(EN_EXCESSIVE_EXCLAMATION)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@prlabeler prlabeler bot added the 📖 Documentation Documentation only changes label Oct 13, 2024
@5ouma 5ouma merged commit ebd98aa into main Oct 13, 2024
@5ouma 5ouma deleted the docs-fmt branch October 13, 2024 01:34
@coderabbitai coderabbitai bot mentioned this pull request Oct 22, 2024
Merged
12 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 7, 2024
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@5ouma 5ouma

Labels

📖 Documentation Documentation only changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@5ouma