[The127]

Problem

The README doesn't say how to get tidegate, where to report a bug or suggest a feature, or how to report a vulnerability. The OpenSSF Best Practices badge asks for the first two, and a security tool's README should point to its security policy.

Change

• Under the description: there's no release yet, so you build tidegate from source.
• Contributing: bugs and feature requests go to GitHub issues.
• A new Security section points to SECURITY.md and asks not to report vulnerabilities in public issues.

Not done or not tested

• Nothing.

Docs

Only the README changes.

Summary by CodeRabbit

• Documentation
  • Clarified that tidegate has not yet been released and that users should build it from source.
  • Added guidance for bug reports and feature suggestions, and directed security reports to a private reporting process.

[The127]

@coderabbitai review

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Run configuration

• Source mode: Auto
• Repository: tidegate-dev/tidegate
• Branch: docs/readme-obtain-feedback
• File: .coderabbit.yaml
• Commit: daa829d
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: 9e51cb11-6f82-454d-820f-d614311dcc21

Commits

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

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

Use the checkbox below for a quick retry:

• Trigger review

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: tidegate-dev/tidegate
• Branch: docs/readme-obtain-feedback
• File: .coderabbit.yaml
• Commit: daa829d
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: 3581a5c8-b0a0-4190-86a3-cbe29f0b22f3

Commits

Reviewing files that changed from the base of the PR and between ddb5d71 and daa829d.

Files ignored due to path filters: 1

• flake.lock is excluded by !**/*.lock, !flake.lock

Files selected for processing: 1

• README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The README explains how to try Tidegate before its first release and where to report bugs, feature suggestions, and vulnerabilities.

Changes: Contribution guidance

Layer / File(s)	Summary
Pre-release and contribution guidance README.md	The README directs readers to the Development instructions to try Tidegate. It adds guidance for bug reports and feature suggestions and directs vulnerability reports to SECURITY.md.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: fjogeleit

Merge Risk: Minimal · up to daa82

The README clarifies how to try Tidegate and where to report issues and vulnerabilities. No concrete blocker is identified; the change is mergeable after normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly and concisely describes the README changes, including the new security section and build instructions.
Description check		The description includes all required sections and explains the problem, changes, testing status, and documentation reviewed.
Docstring Coverage		No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.