Skip to content

feat: add Claude Code agentic config and rewrite README - #8

Open
hamishcrittenden wants to merge 1 commit into
mainfrom
ai-prompt-addition
Open

hamishcrittenden wants to merge 1 commit into
mainfrom
ai-prompt-addition

Conversation

@hamishcrittenden

Copy link
Copy Markdown

Summary

  • Add .claude/ directory with 6 agent definitions, 27 slash commands, and settings for AI-assisted development workflows
  • Add .gitignore for local Claude Code settings
  • Rewrite README.md with comprehensive architecture documentation, deployment prerequisites, CI/CD pipeline details, code coverage notes, and known incomplete/unused items

Test plan

  • Verify README renders correctly on GitHub
  • Confirm .claude/ commands and agents load in Claude Code
  • Check .gitignore excludes local settings as intended

🤖 Generated with Claude Code

Add .claude/ directory with agent definitions, slash commands, and
settings for AI-assisted development workflows. Update README with
comprehensive architecture documentation, deployment prerequisites,
CI/CD details, and known gaps.
@github-actions

Copy link
Copy Markdown

❌ Your current sustainability score is 2. Sustainability scanner suggests 1 improvements to apply to your template.
Check out the details of the sustainability scanner here: https://github.com/AUDD-Digital/n8n-middleware-example/actions/runs/24562625301

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8c435476c2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread README.md
- Terminate TLS at ALB and re-encrypt upstream where possible.
- Keep n8n and database credentials in AWS Secrets Manager; they are injected via ECS secrets.
- Database ingress is restricted to ECS task security groups only.
- ECS tasks and RDS run in private subnets; the ALB is the only internet-facing component.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Fix security note about task subnet placement

This line states that ECS tasks run in private subnets, but the deploy workflow falls back to PublicSubnetIds when ECS_SUBNETS is unset (.github/workflows/deploy-aws-infra.yml, if [ -z "$ECS_SUBNETS" ] ... PublicSubnetIds). That mismatch can cause operators to assume a private-only runtime while the default deployment path is public-subnet based, so the documentation should be corrected (or the workflow default changed).

Useful? React with 👍 / 👎.

- Answer the user's specific questions with concrete evidence

5. **Gather metadata for the research document:**
- Run the `hack/spec_metadata.sh` script to generate all relevant metadata

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Remove dependency on missing metadata script

The new /research_codebase instructions require running hack/spec_metadata.sh, but that script is not present in this repository, so the workflow fails at the metadata step for every invocation. Since this command was added in the same change, it should point to an existing script or provide inline commands so the documented process is executable.

Useful? React with 👍 / 👎.

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.

1 participant