Skip to content

add jkaninda/okapi #5949

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.

Sign up for GitHub

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

Jump to bottom
Open
jkaninda wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add jkaninda/okapi #5949

jkaninda wants to merge 1 commit into from

Conversation

@jkaninda
Copy link
Contributor

@jkaninda jkaninda commented Dec 2, 2025 •
edited by coderabbitai bot
Loading

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

  • forge link (github.com, gitlab.com, etc):
  • pkg.go.dev:
  • goreportcard.com:
  • coverage service link (codecov):

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.
  • I removed the following packages around my addition: (please give a short reason for each removal)

Thanks for your PR, you're awesome! 😎

Summary by CodeRabbit

  • Documentation
    • Updated Web Frameworks section to include Okapi.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 2, 2025 •
edited
Loading

Walkthrough

The README.md file was updated to include Okapi as a new entry in the Web Frameworks section, inserted between Lit and Microservice frameworks. This is a documentation-only change with no code modifications.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md		 Added Okapi framework entry to the Web Frameworks list

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A framework new joins our README sight,
Okapi hops in, positioned just right,
Between Lit and Microservice it stands,
Documentation grows, guided by these hands! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'add jkaninda/okapi' directly and clearly describes the main change: adding a new entry for the jkaninda/okapi package to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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.

@github-actions
Copy link

github-actions bot commented Dec 2, 2025

Automated Quality Checks (from CONTRIBUTING minimum standards)

  • Repo link: missing
  • pkg.go.dev: missing
  • goreportcard: missing
  • coverage: missing

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

coderabbitai[bot]
coderabbitai bot reviewed Dec 2, 2025
View reviewed changes
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: 0

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

3044-3044: Use neutral, concise wording for the new entry.

Alphabetical placement and punctuation look good. Please tone down marketing adjectives to match Awesome list style.

Apply this diff:

-- [Okapi](https://github.com/jkaninda/okapi) - A lightweight, expressive, and minimalist Go web framework with built-in OpenAPI 3.0, Swagger UI, and powerful middleware support.
+- [Okapi](https://github.com/jkaninda/okapi) - Go web framework with built-in OpenAPI 3.0, Swagger UI, and middleware support.

As per coding guidelines, descriptions should be concise and neutral.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2bb07df and 98fc4bf.

📒 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
🧠 Learnings (1)
📓 Common learnings 
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to {README.md,COVERAGE.md} : Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages
⏰ 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

phanirithvij
phanirithvij requested changes Dec 2, 2025
View reviewed changes
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.

https://app.codecov.io/gh/jkaninda/okapi

code coverage requirement for awesome-go is 80%

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

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@phanirithvij phanirithvij phanirithvij requested changes

+1 more reviewer

@kmk142789 kmk142789 kmk142789 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

needs-info\nneeds-coverage\nquality:fail

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jkaninda @phanirithvij @kmk142789