Conversation
These skills are reusable across projects
These files contain context-specific information that agents can read if they read in / make changes in that context.
The README is now much shorter while retaining all essential information, making it faster to scan and easier to find specific usage patterns.
Asked Claude to make AGENTS.md files more concise to make sure that they help agents while keeping token usage low. Bloated AGENTS.md will burn way more tokens and may actually confuse agents more than helping them.
Added a new section detailing project structure, architecture overview, and testing philosophy to provide clearer guidance for developers.
Updated `MADE with` section links to point to "Build & Run" and made the operations table collapsible for better readability.
Created with @afranken as default owner, plus specific paths for server, integration-tests, testsupport, docker, .github, build-config.
afranken
force-pushed
the
5.0.0-maintenance-ctd-2
branch
from
61f2c5e to
3bc25f9
Compare
afranken
force-pushed
the
5.0.0-maintenance-ctd-2
branch
from
3bc25f9 to
5e21dc6
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs comprehensive documentation maintenance for the S3Mock 5.0.0 release. It introduces a modern documentation structure with AI agent context files, improves GitHub community health files, and significantly reorganizes the README for better user experience.
Changes:
- Added AGENTS.md files (root, server/, integration-tests/, testsupport/) providing AI agent context and code style guidelines
- Added .claude/skills/ files (test, implement, document) with Claude-specific skill definitions
- Added GitHub community health files: SECURITY.md, CODEOWNERS, structured issue templates (bug_report.yml, feature_request.yml, config.yml)
- Restructured README.md with Quick Start section, collapsible operations table, improved navigation, and dedicated troubleshooting section
- Updated CONTRIBUTING.md with development setup, architecture references, and code style guidelines
- Enhanced dependabot.yml with dependency grouping to reduce PR noise
- Fixed grammar: "it's" → "its" in CHANGELOG.md
- Deleted obsolete files: docs/tasks.md, .junie/guidelines.md, .github/ISSUE_TEMPLATE.md
Reviewed changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | New root-level agent context: architecture, tech stack, code style, DO/DON'T guidelines |
| server/AGENTS.md | Server module context: Controller→Service→Store flow, error handling, testing patterns |
| integration-tests/AGENTS.md | Integration test patterns: S3TestBase usage, AWS SDK v2, Arrange-Act-Assert |
| testsupport/AGENTS.md | Test framework integrations: JUnit 5, Testcontainers (recommended), TestNG with deprecation notices |
| .claude/skills/test/SKILL.md | Claude test skill: unit vs integration tests, test standards, running tests |
| .claude/skills/implement/SKILL.md | Claude implementation skill: feature implementation flow, code standards |
| .claude/skills/document/SKILL.md | Claude documentation skill: documentation structure, update procedures |
| .github/SECURITY.md | Security policy: supported versions, vulnerability reporting, security measures |
| .github/CONTRIBUTING.md | Contributing guide: development setup, architecture, code style, testing requirements |
| .github/CODEOWNERS | Code ownership: assigns @afranken as default owner for all paths |
| .github/ISSUE_TEMPLATE/bug_report.yml | Structured bug report template with required fields |
| .github/ISSUE_TEMPLATE/feature_request.yml | Structured feature request template with categorization |
| .github/ISSUE_TEMPLATE/config.yml | Issue template configuration with helpful links |
| .github/PULL_REQUEST_TEMPLATE.md | Added checklist items: ktlint format, CHANGELOG update, documentation update |
| .github/dependabot.yml | Added dependency grouping for aws-sdk, spring, maven-plugins, kotlin, github-actions |
| README.md | Major restructure: Quick Start, version compatibility table, migration guides, collapsible operations table, configuration table, improved troubleshooting, architecture diagram |
| CHANGELOG.md | Fixed grammar "it's" → "its", added dependency version updates for 5.0.0 |
| docs/tasks.md | Deleted obsolete improvement tasks document |
| .junie/guidelines.md | Deleted obsolete Junie-specific guidelines (replaced by .claude/skills/) |
| .github/ISSUE_TEMPLATE.md | Deleted generic template (replaced by structured YAML templates) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
Tasks