chore(readme): Update Twitter badge to X and add OpenSSF Scorecard #567
Conversation
Update Twitter badge to X and add OpenSSF Scorecard
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughREADME.md documentation updates: replaced the Twitter badge with an X badge linking to https://x.com/openfga and added an OpenSSF Scorecard badge linking to the project’s scorecard viewer. No code or functionality changes; no public API impacts. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
README.md (3)
840-840: Fix copy-paste errors in retry instructions (extra quotes and filename mismatch).These command typos will break when users copy them.
-`fga tuple write --file tuples.json' --hide-imported-tuples > results.json` +`fga tuple write --file tuples.json --hide-imported-tuples > results.json` -`jq -c '[.failed[] | {user: .tuple_key.user, relation: .tuple_key.relation, object: .tuple_key.object}]' result.json > failed_tuples.json` +`jq -c '[.failed[] | {user: .tuple_key.user, relation: .tuple_key.relation, object: .tuple_key.object}]' results.json > failed_tuples.json` -`fga tuple write --file failed_tuples.json' --hide-imported-tuples ` +`fga tuple write --file failed_tuples.json --hide-imported-tuples`Also applies to: 844-844, 846-846
1036-1036: Close missing quote in JSON context examples.The single quote after the JSON payload is missing, causing the shell to eat the rest of the line.
-... --context '{"ip_address":"127.0.0.1"} --consistency="HIGHER_CONSISTENCY"` +... --context '{"ip_address":"127.0.0.1"}' --consistency="HIGHER_CONSISTENCY"`Apply the same fix to all three examples at Lines 1036, 1063, and 1126.
Also applies to: 1063-1063, 1126-1126
1129-1142: Invalid JSON structure in “List Users” response.There’s an extra
{ … }wrapper; the outer object should directly contain"users": [...].-```json5 -{ - { - "users": [ - { - "object": { - "type": "user", - "id": "anne" - } - } - ] - } -} -``` +```json5 +{ + "users": [ + { + "object": { + "type": "user", + "id": "anne" + } + } + ] +} +```
🧹 Nitpick comments (4)
README.md (4)
10-11: Badges look good; tighten consistency and clarity (style, label).
- The new badges work. For visual consistency with the other shields (which use default style), drop
style=flat-square. Also preferlogo=xoverlogo=twitterto match the X rebrand.- Consider adding an explicit label to the Scorecard badge so readers know what the score represents at a glance.
Apply:
-[](https://x.com/openfga) +[](https://x.com/openfga) -[](https://securityscorecards.dev/viewer/?uri=github.com/openfga/cli) +[](https://securityscorecards.dev/viewer/?uri=github.com/openfga/cli)
60-60: Keep “Resources” consistent with the X rebrand.Rename “Twitter” to “X (formerly Twitter)” and point to x.com.
-- [Twitter](https://twitter.com/openfga) +- [X (formerly Twitter)](https://x.com/openfga)
254-254: Typo: “option” → “optional”.Minor wording fix in the parameter description.
-* `--max-tuples`: Specifies the max number of tuples to include in the output (option, defaults to 100) +* `--max-tuples`: Specifies the max number of tuples to include in the output (optional, defaults to 100)
649-649: Stray trailing slash after link.Removes a dangling “/” that renders oddly.
-For more examples of `.fga.yaml` files, check our [Store File Format documentation](docs/STORE_FILE.md) and the [sample-stores repository](https://github.com/openfga/sample-stores/)/ +For more examples of `.fga.yaml` files, check our [Store File Format documentation](docs/STORE_FILE.md) and the [sample-stores repository](https://github.com/openfga/sample-stores/).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ 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: Test Release Process
- GitHub Check: Tests
Updated README.md to remove duplicate badges and improve formatting.
Update Twitter badge to X and add OpenSSF Scorecard
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit