chore: fix readme section for error handling and contributing guide

[SoulPancake]

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

• Documentation

  • Enhanced README with Client Batch Check navigation and comprehensive Error Handling documentation detailing ApiException usage, error codes, and helper methods with examples.
  • Streamlined contribution guidelines by removing redundant language.

• Tests

  • Code formatting updates.

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

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Documentation updates to CONTRIBUTING.md and README.md remove an outdated note about Pull Request acceptance, consolidate and reorganize the Error Handling section, add navigation for "Client Batch Check", and apply minor test file formatting.

Changes

Cohort / File(s)	Change Summary
Documentation Updates CONTRIBUTING.md, README.md	Removed outdated note stating Pull Requests are not accepted; consolidated Error Handling section in README.md with ApiException details and examples; added "Client Batch Check" entry to table of contents; removed duplicate Error Handling section
Test Formatting test/error_integration_test.py	Added blank line before class decorator for formatting consistency

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• No functional code changes; documentation and formatting only
• All changes are non-critical updates to auxiliary files

Suggested reviewers

• curfew-marathon
• ttrzeng

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 accurately summarizes the main changes: it addresses updates to the README's error handling section and the contributing guide, which aligns with the actual modifications across CONTRIBUTING.md and README.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[dosubot]

Related Documentation

Checked 7 published document(s) in 1 knowledge base(s). No updates required.

^{How did I do? Any feedback?}  

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.17%. Comparing base (1c16fe6) to head (68af65e).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #249   +/-   ##
=======================================
  Coverage   71.17%   71.17%           
=======================================
  Files         137      137           
  Lines       11100    11100           
=======================================
  Hits         7900     7900           
  Misses       3200     3200           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

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 1c16fe6 and ad3ec5e.

📒 Files selected for processing (3)

• CONTRIBUTING.md (1 hunks)
• README.md (2 hunks)
• test/error_integration_test.py (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

CONTRIBUTING.md

13-13: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

README.md

41-41: Link fragments should be valid

(MD051, link-fragments)

⏰ 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: Agent

🔇 Additional comments (2)

test/error_integration_test.py (1)

56-59: LGTM!

The addition of blank line 56 improves readability by separating the constant definition from the test class decorator. No functional changes.

README.md (1)

1287-1309: New Error Handling section is clear and comprehensive.

The section effectively documents:

• Key error handling features (operation context, error codes, helper methods)
• Practical code example showing exception handling and categorization
• Real-world usage patterns for is_validation_error() and is_retryable()

This aligns well with the integration tests added in test/error_integration_test.py and improves SDK documentation.

[Copilot]

Pull request overview

This PR reorganizes the README documentation by moving the "Error Handling" section to a more logical position (after "Retries" instead of after "OpenTelemetry") and updates the CONTRIBUTING.md to remove an outdated note about not accepting pull requests.

Key changes:

• Moved Error Handling section from after OpenTelemetry to after Retries for better document flow
• Removed outdated note in CONTRIBUTING.md stating PRs were not being accepted
• Added blank line formatting in test file

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
README.md	Relocated Error Handling section to appear after Retries section; added Table of Contents entry for "Client Batch Check"
CONTRIBUTING.md	Removed outdated note "[Note: We are not accepting Pull Requests at this time!]" from ToC
test/error_integration_test.py	Added blank line for code formatting

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.