Goal: add documentation to readme reflecting Claude and Codex's use of /goal

Open Beginner friendly
#2 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Start by reading README.md and locate the "Built On" section or another suitable place for brief references. Confirm the official Claude Code and Codex /goal documentation URLs, add both links plus a short description and link for githubnext/autoloop, then run the four grep commands in the issue to verify completion.

Written by the indexing model from the issue text.

Description

goal-completed

Goal

Our readme should contain references to the use of /goal in Claude Code and Codex, with appropriate links. Not extended discussion, but we want to note that we are using this now-standard term.

We also want to make sure we link to https://github.com/githubnext/autoloop which also inspired this repo. Autoloop is a similar goal-driven agentic workflow, with more of an emphasis on scientific exploration.

Completion Contract

The README.md "Built On" section (or a similar appropriate section) links to:

Evidence / Verification

set -euo pipefail
grep -q "autoloop" README.md
grep -qi "claude" README.md
grep -qi "codex" README.md
grep -q "https://github.com/githubnext/autoloop" README.md

All commands must exit 0.

Scope and Constraints

Allowed files:

  • README.md

Do not remove existing content. Keep additions brief — a few lines, not paragraphs.

Iteration Policy

This is a single-run goal. Read the current README, add the references, and verify.

Blocked Stop Condition

If the official /goal documentation URLs for Claude Code or Codex cannot be found or confirmed, add placeholder references noting the feature and stop with a comment listing which URLs need human confirmation.

Dominant language
Python
Stars
10
Forks
2
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from githubnext/goal

All issues in githubnext/goal

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.