Skip to content

docs(rf-api): add loose-assertion anti-patterns - #13

Merged
manykarim merged 2 commits into
MarketSquare:mainfrom
ai94iq:docs/loose-assertions
Nov 17, 2026
Merged

manykarim merged 2 commits into
MarketSquare:mainfrom
ai94iq:docs/loose-assertions

Conversation

@ai94iq

@ai94iq ai94iq commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Adds a loose-assertion reference to rf-requests and rf-restinstance.

Verified: RequestsLibrary keyword names checked against its libdoc (0.9.7). RESTinstance examples not run. Catalog, governance, plugin references and docs voice checks pass.

What this changes

Lists checks that pass on a broken endpoint, like a status-only check after a write, and what to assert instead.

Review checklist

Tick each item, or write "n/a: " after it. Reviewers don't approve a PR
with an unticked item that has no reason (see CONTRIBUTING.md, "Review").

  • Purpose. Each new or changed skill and subagent says what it is for and when to use it, in its description. n/a: no skill description change, only new references
  • Supported versions. catalog.yaml lists the libraries and version ranges the content was checked against, and the Robot Framework range. n/a: no new library, catalog.yaml is unchanged
  • Examples. .robot examples pass robot --dryrun; Python examples run. n/a: inline one-line snippets in a table, no .robot example file
  • Security-relevant changes. Hooks, scripts, MCP configuration, manifests, subagent tools and skill allowed-tools changes are listed below; the security gate passes, and any new baseline entry has a reason. n/a: no hook, script, manifest or tools change
  • Tool permissions. Every subagent declares an explicit tools list; no allowed-tools entry grants unrestricted shell access. n/a: no subagent or allowed-tools change
  • Documentation voice. Text follows the writing rules in CONTRIBUTING.md and passes the docs voice check.

Security-relevant changes

none

Add a reference of checks that pass against a broken endpoint to
rf-requests and rf-restinstance. Each entry names the check to use
instead. Both SKILL.md files link to the new reference.
@ai94iq

ai94iq commented Nov 15, 2026

Copy link
Copy Markdown
Contributor Author

Merge chain: #11, then #12, then #13, then #14, then #15, then #16.

All six merge into main cleanly in this order (dry run on 2026-11-15).

#15 depends on this one. Please merge it first.

Apart from #13 and #15, the PRs do not depend on each other.

@manykarim
manykarim merged commit f31c1da into MarketSquare:main Nov 17, 2026
26 checks passed
@manykarim

Copy link
Copy Markdown
Collaborator

Thank you, @ai94iq! 🎉 This is a really useful reference. The patterns are spot on (resp.ok really is true for 3xx, and a write without a read-back proves very little), and the RequestsLibrary and RESTinstance keywords all exist.

What I did before merging: I merged the current main into your branch, so CI could check it against everything that landed since you opened it. All checks passed, and it's merged now.

One small note for future PRs: since you opened this, we published AI_POLICY.md, and the PR template now has an "AI assistance" section. On new PRs we'd love a line there whenever a tool did a substantial part of the work, plus the command that regenerated bundles/.

Thanks again for the contribution!

ai94iq pushed a commit to ai94iq/robotframework-plugins that referenced this pull request Nov 20, 2026
Task 7.1 of both changes is done: CI on main, a local run of the
AGENTS.md checks, and contributor PRs MarketSquare#13-MarketSquare#16 on the new layout. The
findings are in each tasks.md; the one open policy question (PRs opened
before AI_POLICY.md) is answered in ai-contributor-docs design.md.

Archiving merges the deltas into openspec/specs: ten modified
requirements from repo-cleanup and the new contributor-guidance spec.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FHEmzL3ErAhGQykKWDx2wP
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants