Skip to content

docs: document development workflows, update other documents - #63

Merged
araujof merged 5 commits into
mainfrom
hl/update_docs
Sep 15, 2026
Merged

araujof merged 5 commits into
mainfrom
hl/update_docs

Conversation

@dhl123

@dhl123 dhl123 commented Sep 11, 2026

Copy link
Copy Markdown
Member

Summary

This PR created a CONTRIBUTING.md for developer, and updated README.md, CLAUDE.md, CHANGELOG.md based on recent changes.

Closes: #48

Signed-off-by: Hailun Ding <hailun.ding@ibm.com>
Signed-off-by: Hailun Ding <hailun.ding@ibm.com>
@dhl123 dhl123 changed the title Hl/update docs docs: document development workflows, update other documents Sep 11, 2026
Signed-off-by: Hailun Ding <hailun.ding@ibm.com>
@dhl123
dhl123 marked this pull request as ready for review September 14, 2026 13:33
@dhl123
dhl123 requested a review from araujof as a code owner September 14, 2026 13:33

@araujof araujof left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few findings:

  • HR setup breaks tool calls. CONTRIBUTING.md:168 sets MCP_URL to the agent’s tool-definition endpoint, but examples/hr-agent/agent.py:371 POSTs tool calls to that same variable. Override it with http://localhost:9100/mcp when starting the agent or separate the variables.

  • Security release notes are deleted. CHANGELOG.md:18 removes main’s NLTK/dependency-remediation security entry and dependency-upgrade entry. These unrelated changes should be restored.

  • Test coverage is overstated. README.md:115 claims every stage has a unit/integration pair, but get_current_agent and open_explorer have no unit modules. Adjust the wording or add the tests.

  • Linked issue acceptance criteria are unmet. Issue #48 explicitly requests DEVELOPMENT.md; the PR adds no such file. Its summary also claims Hugo documentation updates, but only four root Markdown files changed.

@dhl123

dhl123 commented Sep 15, 2026

Copy link
Copy Markdown
Member Author

A few findings:

  • HR setup breaks tool calls. CONTRIBUTING.md:168 sets MCP_URL to the agent’s tool-definition endpoint, but examples/hr-agent/agent.py:371 POSTs tool calls to that same variable. Override it with http://localhost:9100/mcp when starting the agent or separate the variables.
  • Security release notes are deleted. CHANGELOG.md:18 removes main’s NLTK/dependency-remediation security entry and dependency-upgrade entry. These unrelated changes should be restored.
  • Test coverage is overstated. README.md:115 claims every stage has a unit/integration pair, but get_current_agent and open_explorer have no unit modules. Adjust the wording or add the tests.
  • Linked issue acceptance criteria are unmet. Issue docs: document development workflows #48 explicitly requests DEVELOPMENT.md; the PR adds no such file. Its summary also claims Hugo documentation updates, but only four root Markdown files changed.

Q1, Q2, and Q3 are fixed.

For Q4, the development workflow has been included in CONTRIBUTING.md. The PR description changed.

Signed-off-by: Hailun Ding <hailun.ding@ibm.com>
Signed-off-by: Hailun Ding <hailun.ding@ibm.com>
@araujof
araujof self-requested a review September 15, 2026 18:07

@araujof araujof left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@araujof
araujof merged commit 0eb63b9 into main Sep 15, 2026
6 checks passed
@araujof
araujof deleted the hl/update_docs branch September 15, 2026 18:07
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.

docs: document development workflows

2 participants