Skip to content

Conversation

@andygeiss
Copy link
Contributor

@andygeiss andygeiss commented Sep 22, 2025

We want to ensure high quality of the packages. Make sure that you've checked the boxes below before sending a pull request.

Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for details.

  • The repo documentation has a pkg.go.dev link.
  • The repo documentation has a coverage service link.
  • The repo documentation has a goreportcard link.
  • The repo has a version-numbered release and a go.mod file.
  • The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged.
  • Continuous integration is used to attempt to catch issues prior to releasing this package to end-users.

Please provide some links to your package to ease the review

Pull Request content

  • The package has been added to the list in alphabetical order.
  • The package has an appropriate description with correct grammar.
  • As far as I know, the package has not been listed here before.

Category quality

Note that new categories can be added only when there are 3 packages or more.

Packages added a long time ago might not meet the current guidelines anymore. It would be very helpful if you could check 3-5 packages above and below your submission to ensure that they also still meet the Quality Standards.

Please delete one of the following lines:

  • The packages around my addition still meet the Quality Standards.

Thanks for your PR, you're awesome! 😎

Summary by CodeRabbit

  • Documentation
    • Added a new “Cloud Native” section with two package entries (descriptions and GitHub links).
    • Updated the table of contents to include the new “Cloud Native” section.
    • A duplicate “Cloud Native” section block was unintentionally added, causing repeated content and links.

coderabbitai[bot]

This comment was marked as resolved.

Repository owner deleted a comment from github-actions bot Oct 4, 2025
Repository owner deleted a comment from github-actions bot Oct 4, 2025
Repository owner deleted a comment from coderabbitai bot Oct 4, 2025
Repository owner deleted a comment from github-actions bot Oct 4, 2025
Repository owner deleted a comment from github-actions bot Oct 4, 2025
Repository owner deleted a comment from github-actions bot Oct 4, 2025
Copy link
Collaborator

@phanirithvij phanirithvij left a comment

Choose a reason for hiding this comment

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

A new category requires at least 3 entries.

Also you have to move any other software that fall into this category from other categories

@andygeiss
Copy link
Contributor Author

Thanks for the feedback. Can I decide which repositories fit into the new category? Or who can help me with that?

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Walkthrough

Added a new top-level "Cloud Native" section to README.md with two package entries and a Contents/navigation item; the same Cloud Native block was inserted twice, producing duplicate content in the document.

Changes

Cohort / File(s) Summary of Changes
Documentation: Cloud Native section
README.md
Added a new top-level "Cloud Native" section with entries for cloud-native-app and cloud-native-utils, updated the Contents/navigation to include it, and unintentionally duplicated the full Cloud Native section block elsewhere in the README.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nibbled the docs with careful delight,
Planted a Cloud Native garden in light—
Two shiny sprouts, app and utils anew,
Oops, doubled the rows; I planted them twice too!
Thump-thump, I’ll prune with a gentle hop. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "feat: add cloud native" accurately describes the main change in the changeset, which adds a new Cloud Native section to the README with associated package entries. The title is clear, concise, and uses appropriate conventional commit syntax. While the title could be marginally more specific (e.g., "feat: add Cloud Native category"), it sufficiently communicates the primary change and is not misleading, vague, or off-topic. The title appropriately reflects the author's stated objective of adding packages under a new "cloud native" category, even though the changeset contains implementation issues such as the duplicate section block noted in the summary.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df3b620 and c09900e.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
README.md

📄 CodeRabbit inference engine (AGENTS.md)

README.md: When modifying the Awesome list, keep categories with at least three entries
Descriptions in the Awesome list must end with a period
Avoid promotional copy; keep descriptions concise and neutral in the Awesome list
Do not remove existing list content unless removal is requested and justified

Files:

  • README.md
**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Keep documentation in English

Files:

  • README.md
{README.md,COVERAGE.md}

📄 CodeRabbit inference engine (AGENTS.md)

Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages

Files:

  • README.md
🪛 markdownlint-cli2 (0.18.1)
README.md

357-357: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: quality

- [Blockchain](#blockchain)
- [Bot Building](#bot-building)
- [Build Automation](#build-automation)
- [Cloud Native](#cloud-native)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove duplicate contents entry

Cloud Native already appears later in the doc. Drop this extra bullet to avoid duplicate TOC entries.

🤖 Prompt for AI Agents
In README.md around line 68, the table-of-contents contains a duplicate "Cloud
Native" entry; remove this extra bullet so the TOC only lists "Cloud Native"
once (delete the line "- [Cloud Native](#cloud-native)" at line 68), then run a
quick local preview or TOC check to confirm no duplicate anchors remain.

@github-actions
Copy link

Automated Quality Checks (from CONTRIBUTING minimum standards)

  • Repo: OK
  • pkg.go.dev: OK
  • goreportcard: OK (grade unknown)
  • coverage: missing

These checks are a best-effort automation and do not replace human review.

Copy link
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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c09900e and b53963b.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
README.md

📄 CodeRabbit inference engine (AGENTS.md)

README.md: When modifying the Awesome list, keep categories with at least three entries
Descriptions in the Awesome list must end with a period
Avoid promotional copy; keep descriptions concise and neutral in the Awesome list
Do not remove existing list content unless removal is requested and justified

Files:

  • README.md
**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Keep documentation in English

Files:

  • README.md
{README.md,COVERAGE.md}

📄 CodeRabbit inference engine (AGENTS.md)

Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages

Files:

  • README.md
🪛 markdownlint-cli2 (0.18.1)
README.md

362-362: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: quality
🔇 Additional comments (1)
README.md (1)

68-68: TOC depends on category outcome.

If you remove the “Cloud Native” section (due to the ≥3 rule), also remove this TOC bullet. If you keep the section with ≥3 entries, no change needed.

As per coding guidelines.

Comment on lines +360 to +368
## Cloud Native

_Libraries for building Cloud Native Applications_

- [cloud-native-app](https://github.com/andygeiss/cloud-native-app) - This app automates the process of bootstrapping a repository. It generates a project structure with everything you need to start coding right away.
- [cloud-native-utils](https://github.com/andygeiss/cloud-native-utils) - A collection of high-performance, modular utilities for enhancing testing, transactional consistency, efficiency, security and stability in cloud-native Go applications.

**[⬆ back to top](#contents)**

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

New category must list at least three projects (currently two).

Awesome‑Go requires ≥3 entries per category. Please either:

  • Add at least a third vetted project under “Cloud Native”, or
  • Drop this category for now and move:
    • cloud-native-app → “Project Layout” (or “Generators”),
    • cloud-native-utils → “Utilities”.

Also tighten wording and punctuation to match list style. Suggested edits below.

As per coding guidelines.

- _Libraries for building Cloud Native Applications_
+ _Libraries for building cloud-native applications._

- - [cloud-native-app](https://github.com/andygeiss/cloud-native-app) - This app automates the process of bootstrapping a repository. It generates a project structure with everything you need to start coding right away. 
+ - [cloud-native-app](https://github.com/andygeiss/cloud-native-app) - Scaffold generator to bootstrap a Go repository with a standard project structure and CI.

- - [cloud-native-utils](https://github.com/andygeiss/cloud-native-utils) - A collection of high-performance, modular utilities for enhancing testing, transactional consistency, efficiency, security and stability in cloud-native Go applications. 
+ - [cloud-native-utils](https://github.com/andygeiss/cloud-native-utils) - Utilities for testing support, transactional consistency helpers, and stability tooling for cloud-native Go apps.

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

362-362: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🤖 Prompt for AI Agents
In README.md around lines 360 to 368, the "Cloud Native" category currently
lists only two projects which violates the requirement of at least three
entries; either add a vetted third project to this category (include repo link
and a one-line description) or delete the "Cloud Native" section and move the
two existing entries: change "cloud-native-app" to be listed under "Project
Layout" (or "Generators") and "cloud-native-utils" under "Utilities"; also
tighten wording and punctuation on the moved/added bullets to match list style
(concise one-line descriptions, consistent punctuation and spacing).


## Cloud Native

_Libraries for building Cloud Native Applications_
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

End the tagline with a period and use “cloud‑native” casing.

Minor style fix to match surrounding sections.

As per coding guidelines.

- _Libraries for building Cloud Native Applications_
+ _Libraries for building cloud-native applications._
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
_Libraries for building Cloud Native Applications_
_Libraries for building cloud-native applications._
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

362-362: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🤖 Prompt for AI Agents
In README.md around line 362, the tagline "_Libraries for building Cloud Native
Applications_" should be updated for style: change "Cloud Native" to
lowercase-cased "cloud-native" and add a trailing period. Replace the existing
line with "Libraries for building cloud-native applications." ensuring the
hyphen and final period are included.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants