Skip to content

GH-186 Make readme great again.#208

Merged
vLuckyyy merged 4 commits intomasterfrom
make-readme-great-again
Mar 22, 2025
Merged

GH-186 Make readme great again.#208
vLuckyyy merged 4 commits intomasterfrom
make-readme-great-again

Conversation

@vLuckyyy
Copy link
Copy Markdown
Member

Fixes: #186

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 22, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • assets/readme-banner.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request updates the README file to align with the new features of the EternalCombat plugin. The file now reflects the updated version number (from 1.21.1 to 1.21.4) and highlights the key aspects of EternalCombat 2.0, such as enhanced combat logging, configurable spawn protection, and customizable combat options. New sections detail plugin functionality, permissions, placeholders, and developer API instructions. Additionally, contributing guidelines and bug reporting instructions have been clarified. There are no changes to the exported or public entities.

Assessment against linked issues

Objective Addressed Explanation
Improve README documentation (#186)

🪧 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 generate docstrings to generate docstrings for this 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.

Copy link
Copy Markdown
Contributor

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

🧹 Nitpick comments (7)
README.md (7)

5-7: Alt Text for Badge Images:
The badge image links are a great visual touch. Consider adding descriptive alt text (e.g., ![SpigotMC Badge](...)) to improve accessibility.


9-11: Alt Text for Additional Badges:
Similar to the previous images, please add alt text for these badges (e.g., ![Discord Chat Badge](...)) to help with accessibility and SEO.


30-34: Alt Text for Combat Log GIF:
In the Combat Logging bullet, the GIF is an effective visual aid. Please add alt text (e.g., ![Combat Log Demo](...)) to support accessibility.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

33-33: Images should have alternate text (alt text)
null

(MD045, no-alt-text)


35-39: Alt Text for Spawn Protection GIF:
The Spawn Protection section includes a useful GIF. Adding descriptive alt text (e.g., ![Spawn Protection Demo](...)) would enhance accessibility.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

38-38: Images should have alternate text (alt text)
null

(MD045, no-alt-text)


90-90: Heading Punctuation Consistency:
Consider removing the trailing colon from the "#### 1. Add repository:" heading for a cleaner, more consistent look.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

90-90: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


111-111: Heading Punctuation Consistency:
For the "#### 2. Add dependency:" heading, consider removing the trailing colon to match the style used in other headings.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

111-111: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


137-144: Reporting Issues & Tone:
The Reporting Issues section effectively guides users on how to report bugs. Consider toning down the exclamation in the final call-to-action for a more balanced, professional tone.

🧰 Tools
🪛 LanguageTool

[style] ~144-~144: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 5314 characters long)
Context: ...Combat 2.0 now and let the battles begin!

(EN_EXCESSIVE_EXCLAMATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 726f1aa and f9792fb.

⛔ Files ignored due to path filters (2)
  • assets/border.gif is excluded by !**/*.gif
  • assets/combatlog.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~47-~47: When ‘blacklist-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... | Commands | Whitelist or blacklist specific commands in combat. | | D...

(SPECIFIC_HYPHEN)


[style] ~144-~144: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 5314 characters long)
Context: ...Combat 2.0 now and let the battles begin!

(EN_EXCESSIVE_EXCLAMATION)

🪛 markdownlint-cli2 (0.17.2)
README.md

33-33: Images should have alternate text (alt text)
null

(MD045, no-alt-text)


38-38: Images should have alternate text (alt text)
null

(MD045, no-alt-text)


90-90: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


111-111: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

🔇 Additional comments (11)
README.md (11)

16-24: Updated Compatibility & Requirements Info:
The updated "Information" section clearly communicates supported Minecraft versions and Java requirements. Nice and clear update!


25-29: Enhanced Feature Overview:
The "How Does EternalCombat Work?" section gives a solid overview of the plugin’s features. The description is engaging and informative.


40-54: Comprehensive Feature Table:
The table listing customizable combat options is well-organized and clear. Great job laying out the features!

🧰 Tools
🪛 LanguageTool

[uncategorized] ~47-~47: When ‘blacklist-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... | Commands | Whitelist or blacklist specific commands in combat. | | D...

(SPECIFIC_HYPHEN)


55-57: Engaging Call-to-Action:
The YouTube presentation link is a nice touch and encourages users to learn more. Everything looks good in this section.


58-69: Clear Permissions Details:
The permissions section is neatly formatted and clearly explains the available commands. Excellent work!


70-83: Well-Structured PlaceholderAPI Section:
The updated PlaceholderAPI section with its accompanying table is informative and easy to follow.


92-98: Gradle Repository Block Looks Good:
The provided Gradle repository configuration is clear and correct.


100-109: Maven Repository Block is Correct:
The Maven repository configuration is accurately formatted and clear.


112-118: Gradle Dependency Declaration:
The Gradle dependency snippet is concise and correct.


119-129: Maven Dependency Declaration:
The Maven dependency configuration is clear and correctly formatted.


131-136: Contributing Section Clarity:
The "Contributing" section is welcoming and clearly directs users to the guidelines. Great job!

[![Available on Modrinth](https://raw.githubusercontent.com/vLuckyyy/badges/main/avaiable-on-modrinth.svg)](https://modrinth.com/plugin/eternalcombat)
[![Available on Hangar](https://raw.githubusercontent.com/vLuckyyy/badges/main/avaiable-on-hangar.svg)](https://hangar.papermc.io/EternalCodeTeam/eternalcombat)

[![Patreon](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/donate/patreon-plural_vector.svg)](https://www.patreon.com/eternalcode)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

maybe add kofi as a way to support our organisation

@vLuckyyy vLuckyyy merged commit 4cd8367 into master Mar 22, 2025
2 checks passed
@vLuckyyy vLuckyyy deleted the make-readme-great-again branch March 22, 2025 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make readme great again

3 participants