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

[guidelines] workshop/25-audit-and-observability.md: multi-line prompt violates single-sentence prompt rule

Closed Beginner friendly
  • Is something wrong?
#3,590 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
Under an hour
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Open workshop/25-audit-and-observability.md and inspect the reported prompt block. Rewrite the learner-facing prompt as one clear sentence, moving the report-pasting instruction into surrounding prose. Done means the prompt follows the single-sentence rule while retaining the intended audit request.

Written by the indexing model from the issue text.

Description

documentation guidelines

File reviewed

workshop/25-audit-and-observability.md

Violations

Prompt-simplicity rule (AI agent guidance)

Offending text:

/agentic-workflows Here is my audit report. The agent called github.list_issues
three times and AIC was higher than expected. Help me understand why and
suggest how to reduce it.

(paste report here)

Suggested fix:
Guidelines require prompts shown to learners to be "a single clear sentence" that "a human would write in one shot," avoiding multi-part instructions inside the prompt block. This block spans three sentences plus a placeholder line. Shorten it to one sentence, e.g. "Use the /agentic-workflows skill to review this audit report and explain why github.list_issues was called three times and AIC was higher than expected," and move the <paste report here> instruction to the surrounding prose instead of inside the prompt block.

[!WARNING]

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • github.github.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "github.github.com"

See Network Configuration for more information.

Generated by 📋 Guidelines Enforcer · copilot · auto · 162.9 AIC · ⌖ 14.5 AIC · ⊞ 9.1K · ◷

  • expires on Sep 27, 2026, 4:03 AM UTC
Dominant language
JavaScript
Stars
52
Forks
26
Avg merge
12h 54m
Merged PRs (30d)
17

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.