-
-
Couldn't load subscription status.
- Fork 12.7k
feat(docs): Add 'infux' (caching library) with required badges (#5757) #5868
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
base: main
Are you sure you want to change the base?
feat(docs): Add 'infux' (caching library) with required badges (#5757) #5868
Conversation
|
Automated Quality Checks (from CONTRIBUTING minimum standards)
These checks are a best-effort automation and do not replace human review. |
WalkthroughUpdated README documentation: changed the InfluxDB repository link from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 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
⏰ 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). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
README.md (1)
750-750: Correct repo link for InfluxDB.Pointing to influxdata/influxdb is correct.
There was a problem hiding this 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 (1)
README.md (1)
718-718: Tone: remove promotional phrasing from “infux” descriptionKeep entries neutral. Suggest simplifying to align with Awesome list guidelines.
As per coding guidelines
- - [infux](https://github.com/VectroLabs/infux) - A high-performance, in-memory caching library for Go. + - [infux](https://github.com/VectroLabs/infux) - In-memory caching library for Go.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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
⏰ 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). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
README.md (1)
751-751: influxdb org link fix is correctUpdated to influxdata/influxdb. LGTM.
|
Hello @avelino and maintainers, I've implemented the move to the 'Caches' section as requested, and simplified the syntax, but the PR is still being blocked by the "PR Quality Checks". Based on the failure logs (Critical quality checks failed), it appears the automated system is flagging the 'infux' package itself for missing popularity/test coverage criteria, rather than a syntax error in the README. Since this seems to be a Critical Quality Check failure, could you please confirm if this package simply does not meet the minimum requirements for inclusion in the Awesome List? If so, I will close the PR and find an alternative contribution. Thank you very much for your time and clarification! |
|
Hi @lucass-barreto, the automated checks for this PR failed. Please review the build logs and fix the issues. Specifically, the |
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.
Please provide some links to your package to ease the review
Pull Request content
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:
Thanks for your PR, you're awesome! 😎
Summary by CodeRabbit