Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[workflow-editor] Trim duplicated guideline text in workshop-author.md

Open Beginner friendly
  • Is something wrong?
#4,246 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, javascript
Domain
devops, documentation

Research direction

Read .github/workflows/workshop-author.md alongside .github/workflows/guidelines.md to verify the duplicated sections and the existing instruction to apply the shared guidelines. The issue says to replace the duplicated lists with pointers; regenerate .github/workflows/workshop-author.lock.yml using gh aw compile. Done when the workflow refers to the shared rules and the lock file is regenerated.

Written by the indexing model from the issue text.

Description

agentic-workflows documentation workflow-editor

[!CAUTION]
Protected files were modified in this change.
This pull request is in request_review mode and requires explicit human scrutiny before merge.

Protected files: .github/workflows/workshop-author.lock.yml, .github/workflows/workshop-author.md

What changed

.github/workflows/workshop-author.md restated two whole rule sections verbatim
from .github/workflows/guidelines.md — the "Codespaces-first environment"
bullet list and the alert-callout formatting rules — even though the workflow
already instructs the agent to "read .github/workflows/guidelines.md and
apply it while authoring" earlier in the same file.

Why

Keeping two copies of the same rules risks drift: if guidelines.md is
updated (e.g. the alert-level ceiling or gh delay rule changes), the
duplicated copy in workshop-author.md would silently go stale. The shared
guidelines file is the single source of truth for authoring workflows.

How

Replaced the duplicated bullet lists in workshop-author.md with short
pointers back to the relevant sections of guidelines.md, which the agent
already has loaded in context. No behavior change — the agent still applies
the exact same rules, just from one source instead of two.

Files changed

  • .github/workflows/workshop-author.md — trimmed duplicated sections
  • .github/workflows/workshop-author.lock.yml — regenerated via gh aw compile

This keeps the workflow source lean and Skills-like: direct instructions with
a single authoritative reference, rather than restating rules the agent
already read.

Generated by ✂️ Workflow Skills Editor · copilot · auto · 76.5 AIC · ⌖ 9.99 AIC · ⊞ 9.6K · ◷

  • expires on Oct 7, 2026, 7:44 AM UTC

[!NOTE]
This was originally intended as a pull request, but the git push operation failed.

Original error: The process '/usr/bin/git' failed with exit code 1

Workflow Run: View run details and download bundle artifact

The bundle file is available in the agent artifact in the workflow run linked above.

Create the pull request manually 
# Download the artifact from the workflow run
gh run download '37430925381' -n agent -D '/tmp/agent-37430925381'

# Resolve the bundle source ref, fetch it into a temporary ref, then create the local branch
bundle_path='/tmp/agent-37430925381/aw-workflow-editor-trim-workshop-author-duplication.bundle'
temp_ref='refs/bundles/create-pr-workflow-editor-trim-workshop-author-duplication-c19269f4410b8410-02e699e1'
target_ref='refs/heads/workflow-editor/trim-workshop-author-duplication-c19269f4410b8410'
bundle_source_ref=$(git bundle list-heads "$bundle_path" | awk '$2 ~ /^refs\/heads\// { print $2 }')
if [ -z "$bundle_source_ref" ]; then
  bundle_source_ref=$(git bundle list-heads "$bundle_path" | awk '$2 == "HEAD" { print $2 }')
fi
if [ "$(printf '%s\n' "$bundle_source_ref" | sed '/^$/d' | wc -l | tr -d ' ')" != "1" ]; then
  echo "Expected exactly one bundle source ref, found: $bundle_source_ref" >&2
  exit 1
fi
git fetch "$bundle_path" "${bundle_source_ref}:${temp_ref}"
git update-ref "$target_ref" "$temp_ref"
git checkout 'workflow-editor/trim-workshop-author-duplication-c19269f4410b8410'
# Ensure the working tree matches the updated branch
git reset --hard
# Remove the temporary bundle ref
git update-ref -d "$temp_ref"

# Push the branch to the target remote
git push 'origin' 'workflow-editor/trim-workshop-author-duplication-c19269f4410b8410'

# Create the pull request
gh pr create --title '[workflow-editor] Trim duplicated guideline text in workshop-author.md' --base 'main' --head 'workflow-editor/trim-workshop-author-duplication-c19269f4410b8410' --repo 'githubnext/gh-aw-workshop'
Dominant language
JavaScript
Stars
51
Forks
23
Avg merge
11h 32m
Merged PRs (30d)
22

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

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/gh-aw-workshop

All issues in githubnext/gh-aw-workshop

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.