[Test] Add a CONTRIBUTING.md file

[aidandaly24]

Add a basic CONTRIBUTING.md file to the repository with the following sections:

1. Getting Started - How to clone and set up the project
2. Development Workflow - Branch naming, commit messages
3. Pull Requests - How to submit a PR

Keep it simple and concise (under 50 lines).

[aidandaly24]

I'll start by exploring the repository to understand its structure and any existing contributing guidelines or related files.[MEMORY: repo] Repository already has a CONTRIBUTING.md file (4235 bytes). The issue asks to add one, but it already exists. Need to check its current content.

Interesting — there's already a CONTRIBUTING.md file. Let me examine its current content, along with the README and package.json for context on setup instructions.[MEMORY: repo] The existing CONTRIBUTING.md is a comprehensive 100+ line file with sections on: Reporting Bugs, Contributing via PRs, Finding contributions, Code of Conduct, Security, Development Setup, Related Packages, and Licensing. It references Amazon/AWS-specific resources.

[MEMORY: issue] The issue asks to "Add a basic CONTRIBUTING.md file" with 3 specific sections (Getting Started, Development Workflow, Pull Requests) and keep it under 50 lines. Since a CONTRIBUTING.md already exists, this means replacing the existing file with a simpler, more concise version matching the issue's requirements.

[MEMORY: pattern] The repo is a TypeScript/Node.js CLI project using npm, vitest for testing, eslint/prettier for linting/formatting, and husky for git hooks.

Let me also check if there are any CI workflows or tests that might validate the CONTRIBUTING.md file:[MEMORY: repo] CI workflows include build-and-test.yml and lint.yml. The lint-staged config in package.json runs prettier --check on .md files, so the new CONTRIBUTING.md must pass prettier formatting.

Let me check the prettier config and the lint workflow to understand formatting requirements:[MEMORY: pattern] CI runs npm run format:check (prettier --check .) on PRs. The prettierrc has printWidth: 120 and proseWrap: "always". This means markdown prose will be wrapped at 120 characters. The CONTRIBUTING.md must conform to these prettier settings.

Now I have all the information needed to create the plan. Let me also quickly check the PR title workflow to understand naming conventions:[MEMORY: pattern] PR titles must follow conventional commits format (e.g., docs: add contributing guide), lowercase subject. This is relevant for the PR that will be created.

Now I have a complete picture. Here's the plan:

---

Implementation Plan

Summary

The issue requests replacing the existing CONTRIBUTING.md file with a simpler, more concise version (under 50 lines) containing exactly three sections: Getting Started, Development Workflow, and Pull Requests. The current CONTRIBUTING.md is a verbose ~100-line file with many sections. It needs to be replaced entirely with a streamlined version that matches the issue's specifications while conforming to the repository's prettier formatting rules (printWidth: 120, proseWrap: "always").

Files to Modify

File	Action	Description
CONTRIBUTING.md	Replace (overwrite entire contents)	Replace the existing ~100-line file with a concise <50-line version containing the 3 required sections

Implementation Approach

Replace CONTRIBUTING.md with a new file containing exactly these sections:

1. Title: # Contributing to AgentCore CLI

2. Section 1: Getting Started — How to clone and set up the project:

   • Clone the repository: git clone https://github.com/aidandaly24/agentcore-cli.git
   • cd agentcore-cli
   • Prerequisites: Node.js 20+, npm
   • Install dependencies: npm install
   • Build: npm run build
   • Run tests: npm test

3. Section 2: Development Workflow — Branch naming and commit messages:

   • Create a feature branch from main (e.g., feat/add-feature, fix/bug-description)
   • Follow conventional commit messages: feat:, fix:, docs:, refactor:, test:, chore: (derived from the PR title validation in .github/workflows/pr-title.yml)
   • Commit subjects must start with a lowercase letter
   • Run npm run lint and npm run format:check before committing

4. Section 3: Pull Requests — How to submit a PR:

   • Every PR must be linked to an issue (reference with Closes #issue-number)
   • Ensure all tests pass: npm test
   • PR titles must follow conventional commit format (e.g., feat: add new command)
   • Keep PRs focused on a single change

Formatting requirements:

• The file must pass prettier --check with the repo's .prettierrc config:
  • printWidth: 120
  • proseWrap: "always" (prose lines will be wrapped at 120 chars)
• Lines should not exceed 120 characters (prettier will enforce this for prose)
• Use 2-space indentation if any indentation is needed
• Ensure a trailing newline at end of file

Line count constraint: The final file must be under 50 lines total, as specified in the issue.

Edge Cases & Risks

1. Prettier formatting: The proseWrap: "always" setting means long prose lines will be flagged by prettier --check. Ensure no prose line exceeds 120 characters. Write sentences that naturally break at or before 120 chars.

2. Secretlint: The CI also runs npm run secrets:check (secretlint) on all files. The CONTRIBUTING.md should not contain anything that looks like a secret (API keys, tokens, etc.). The clone URL https://github.com/aidandaly24/agentcore-cli.git is fine.

3. Existing references: No other files in the repo appear to link to specific sections/anchors within CONTRIBUTING.md, so replacing the content won't break any cross-references. The README.md does not link to CONTRIBUTING.md.

4. Loss of information: The existing CONTRIBUTING.md has useful content (security reporting, code of conduct references, development setup details). However, the issue explicitly asks for a simple, concise replacement. Some of this information exists in other files (SECURITY.md, CODE_OF_CONDUCT.md, AGENTS.md).

Testing Strategy

1. Prettier check: After creating the file, run npx prettier --check CONTRIBUTING.md to verify it passes formatting.
2. Line count: Verify the file is under 50 lines with wc -l CONTRIBUTING.md.
3. CI validation: The PR will automatically run the lint.yml workflow which includes npm run format:check (prettier on all files) and npm run secrets:check.
4. Manual review: Verify the 3 required sections are present and the content is accurate for this repository.

[aidandaly24]

A couple of notes on the plan:

1. Please don't remove the existing content entirely — instead, keep the Security and Code of Conduct references as a short section at the bottom.
2. The Getting Started section should also mention how to run the CLI locally after building (e.g. node dist/index.js or npm link).
3. Looks good otherwise, go ahead and build it.

[aidandaly24]

Let me quickly verify the existing CONTRIBUTING.md content and check for any references to Security and Code of Conduct sections that the user wants preserved.[MEMORY: repo] The repo has both SECURITY.md and CODE_OF_CONDUCT.md as standalone files at the root. The existing CONTRIBUTING.md references the Amazon Open Source Code of Conduct and AWS vulnerability reporting page. The new file should link to these standalone files instead.

[MEMORY: repo] The CLI binary is at dist/cli/index.mjs and the bin field in package.json maps agentcore to dist/cli/index.mjs. For local dev, npm run cli runs npx tsx src/cli/index.ts. There's also npm link mentioned in the existing CONTRIBUTING.md for CDK package linking.

Now I have all the context needed. Here is the revised plan:

---

Revised Implementation Plan

Summary

Replace the existing CONTRIBUTING.md file (~100 lines) with a concise version (under 50 lines) containing the three sections requested in the issue (Getting Started, Development Workflow, Pull Requests), plus a short Security & Code of Conduct section at the bottom that preserves references from the original file. The Getting Started section will include instructions for running the CLI locally after building.

Files to Modify

File	Action	Description
CONTRIBUTING.md	Replace (overwrite entire contents)	Replace the existing ~100-line file with a concise <50-line version containing the 3 required sections + a short Security & Code of Conduct section at the bottom

Implementation Approach

Replace CONTRIBUTING.md with a new file structured as follows (target: ~45 lines to stay under 50):

1. Title: # Contributing to AgentCore CLI

   • One-line intro: "Thank you for your interest in contributing!"

2. Section 1: Getting Started — How to clone and set up the project:

   • Prerequisites: Node.js 20+, npm
   • Clone: git clone https://github.com/aidandaly24/agentcore-cli.git && cd agentcore-cli
   • Install: npm install
   • Build: npm run build
   • Run tests: npm test
   • Run the CLI locally (per user feedback):
     • During development (without building): npm run cli (which runs npx tsx src/cli/index.ts)
     • After building: node dist/cli/index.mjs
     • Or use npm link to make the agentcore command available globally

3. Section 2: Development Workflow — Branch naming and commit conventions:

   • Create a feature branch from main (e.g., feat/add-feature, fix/bug-description)
   • Use conventional commit messages: feat:, fix:, docs:, refactor:, test:, chore:
   • Commit subjects must start with a lowercase letter
   • Run npm run lint and npm run format:check before pushing

4. Section 3: Pull Requests — How to submit a PR:

   • Every PR must be linked to an issue (use Closes #issue-number)
   • Ensure all tests pass: npm test
   • PR titles must follow conventional commit format (e.g., feat: add new command)
   • Keep PRs focused on a single change

5. Section 4: Security & Code of Conduct (short, ~4-5 lines, per user feedback to preserve these references):

   • Link to SECURITY.md: "To report a security issue, please see SECURITY.md."
   • Link to CODE_OF_CONDUCT.md: "This project follows our Code of Conduct."
   • Link to LICENSE: "See LICENSE for licensing details."

Formatting requirements:

• Must pass prettier --check with the repo's .prettierrc config:
  • printWidth: 120
  • proseWrap: "always" (prose lines will be wrapped at 120 chars)
• No prose line should exceed 120 characters
• Use 2-space indentation if any indentation is needed
• Ensure a trailing newline at end of file
• Use standard markdown formatting (ATX headings with ##, fenced code blocks with triple backticks)

Line count constraint: The final file must be under 50 lines total. Budget:

• Title + intro: ~3 lines
• Getting Started: ~12 lines (including code blocks and local CLI instructions)
• Development Workflow: ~8 lines
• Pull Requests: ~8 lines
• Security & Code of Conduct: ~5 lines
• Blank separator lines between sections: ~4 lines
• Total: ~40 lines (well under 50)

Edge Cases & Risks

1. Prettier formatting: The proseWrap: "always" setting means long prose lines will be flagged by prettier --check. Ensure no prose line exceeds 120 characters. Write sentences that naturally break at or before 120 chars. The build agent should run npx prettier --write CONTRIBUTING.md after creating the file to auto-format, then verify with npx prettier --check CONTRIBUTING.md.

2. Secretlint: The CI runs npm run secrets:check (secretlint) on all files. The CONTRIBUTING.md should not contain anything that looks like a secret. The clone URL https://github.com/aidandaly24/agentcore-cli.git is safe.

3. Line count: With the added Security & Code of Conduct section and local CLI instructions, the file will be slightly longer than the original plan. Budget carefully to stay under 50 lines. If tight, use concise phrasing and combine related points.

4. Loss of information: The existing CONTRIBUTING.md has detailed content (bug reporting templates, forking instructions, CDK package linking, end-to-end testing). Most of this is covered by other files (AGENTS.md has development details, SECURITY.md covers security reporting). The user explicitly approved replacing the bulk of the content while keeping Security & Code of Conduct references.

5. No other files reference CONTRIBUTING.md anchors: Verified that README.md and other files don't link to specific sections within CONTRIBUTING.md, so replacing content won't break cross-references.

Testing Strategy

1. Prettier check: After creating the file, run npx prettier --check CONTRIBUTING.md to verify it passes formatting. Ideally run npx prettier --write CONTRIBUTING.md first to auto-format, then verify.
2. Line count: Verify the file is under 50 lines with wc -l CONTRIBUTING.md.
3. Content verification: Confirm all 4 sections are present:
   • Getting Started (with clone, install, build, test, and local CLI run instructions)
   • Development Workflow (branch naming, conventional commits, lint/format)
   • Pull Requests (issue linking, tests, PR title format)
   • Security & Code of Conduct (links to SECURITY.md, CODE_OF_CONDUCT.md, LICENSE)
4. Link verification: Confirm that the relative links (SECURITY.md, CODE_OF_CONDUCT.md, LICENSE) point to files that actually exist in the repo root (verified: all three exist).
5. CI validation: The PR will automatically run the lint.yml workflow which includes npm run format:check (prettier on all files) and npm run secrets:check.