docs: improve CONTRIBUTING.md and add "How to Contribute" links across docs#805
Open
brunoborges wants to merge 6 commits intogithub:stagedfrom
Open
docs: improve CONTRIBUTING.md and add "How to Contribute" links across docs#805brunoborges wants to merge 6 commits intogithub:stagedfrom
brunoborges wants to merge 6 commits intogithub:stagedfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates repository documentation to improve contribution guidance and adds/updates a broad set of agent/command content across multiple plugins.
Changes:
- Added “How to Contribute” links across generated
docs/README.*.mdpages and updatedeng/constants.mjstemplates. - Expanded
CONTRIBUTING.mdnavigation and added new contribution guidance (notably for hooks), plus workflow spec alignment updates inAGENTS.md. - Introduced multiple new plugin agent/command markdown files (polyglot test suite, partner agents, OpenAPI generators, GEM team agents, etc.).
Reviewed changes
Copilot reviewed 129 out of 198 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/polyglot-test-agent/agents/polyglot-test-tester.md | Adds a tester sub-agent definition and usage guidance for the polyglot test pipeline |
| plugins/polyglot-test-agent/agents/polyglot-test-researcher.md | Adds a research sub-agent definition that writes .testagent/research.md |
| plugins/polyglot-test-agent/agents/polyglot-test-planner.md | Adds a planning sub-agent definition that writes .testagent/plan.md |
| plugins/polyglot-test-agent/agents/polyglot-test-linter.md | Adds a linter/formatter sub-agent definition with command discovery rules |
| plugins/polyglot-test-agent/agents/polyglot-test-implementer.md | Adds an implementation sub-agent definition for executing plan phases |
| plugins/polyglot-test-agent/agents/polyglot-test-generator.md | Adds an orchestration agent for the Research → Plan → Implement flow |
| plugins/polyglot-test-agent/agents/polyglot-test-fixer.md | Adds a compilation error fixer sub-agent definition |
| plugins/polyglot-test-agent/agents/polyglot-test-builder.md | Adds a build sub-agent definition with command discovery rules |
| plugins/partners/agents/pagerduty-incident-responder.md | Adds a partner agent for PagerDuty incident response using PagerDuty MCP tools |
| plugins/partners/agents/octopus-deploy-release-notes-mcp.md | Adds a partner agent for generating Octopus Deploy release notes via MCP server |
| plugins/partners/agents/neon-optimization-analyzer.md | Adds a partner agent for Neon query performance analysis on Neon database branches |
| plugins/partners/agents/neon-migration-specialist.md | Adds a partner agent for safe Neon migration workflows using branching |
| plugins/partners/agents/mongodb-performance-advisor.md | Adds a partner agent for MongoDB performance analysis in readonly mode |
| plugins/partners/agents/lingodotdev-i18n.md | Adds a partner agent for checklist-driven i18n implementation via Lingo MCP |
| plugins/partners/agents/jfrog-sec.md | Adds a partner agent for security remediation constrained to JFrog MCP tooling |
| plugins/partners/agents/elasticsearch-observability.md | Adds a partner agent for Elastic o11y/security/search workflows using an MCP server |
| plugins/partners/agents/diffblue-cover.md | Adds a partner agent for Diffblue Cover unit test generation via MCP server |
| plugins/partners/agents/arm-migration.md | Adds a partner agent for migrating workloads from x86 to Arm using an MCP container |
| plugins/partners/agents/amplitude-experiment-implementation.md | Adds a partner agent for implementing Amplitude experiments via MCP tools |
| plugins/openapi-to-application-python-fastapi/commands/openapi-to-application-code.md | Adds a reusable command for generating a FastAPI app from an OpenAPI spec |
| plugins/openapi-to-application-python-fastapi/agents/openapi-to-application.md | Adds an OpenAPI-to-app generator agent definition (FastAPI plugin) |
| plugins/openapi-to-application-nodejs-nestjs/commands/openapi-to-application-code.md | Adds a reusable command for generating a NestJS app from an OpenAPI spec |
| plugins/openapi-to-application-nodejs-nestjs/agents/openapi-to-application.md | Adds an OpenAPI-to-app generator agent definition (NestJS plugin) |
| plugins/openapi-to-application-java-spring-boot/commands/openapi-to-application-code.md | Adds a reusable command for generating a Spring Boot app from an OpenAPI spec |
| plugins/openapi-to-application-java-spring-boot/agents/openapi-to-application.md | Adds an OpenAPI-to-app generator agent definition (Spring Boot plugin) |
| plugins/openapi-to-application-go/commands/openapi-to-application-code.md | Adds a reusable command for generating a Go app from an OpenAPI spec |
| plugins/openapi-to-application-go/agents/openapi-to-application.md | Adds an OpenAPI-to-app generator agent definition (Go plugin) |
| plugins/openapi-to-application-csharp-dotnet/commands/openapi-to-application-code.md | Adds a reusable command for generating a .NET app from an OpenAPI spec |
| plugins/openapi-to-application-csharp-dotnet/agents/openapi-to-application.md | Adds an OpenAPI-to-app generator agent definition (.NET plugin) |
| plugins/mcp-m365-copilot/agents/mcp-m365-agent-expert.md | Adds an agent definition for building M365 Copilot declarative agents with MCP |
| plugins/kotlin-mcp-development/agents/kotlin-mcp-expert.md | Adds an agent definition for Kotlin MCP server development with the official SDK |
| plugins/java-development/commands/java-springboot.md | Adds a Java/Spring Boot best-practices command document |
| plugins/java-development/commands/java-junit.md | Adds a JUnit 5 best-practices command document |
| plugins/java-development/commands/java-docs.md | Adds a Java documentation/Javadoc best-practices command document |
| plugins/java-development/commands/create-spring-boot-java-project.md | Adds a step-by-step Spring Boot project skeleton creation guide |
| plugins/go-mcp-development/agents/go-mcp-expert.md | Adds an agent definition for Go MCP server development with the official SDK |
| plugins/gem-team/agents/gem-reviewer.md | Adds a security-focused reviewer agent definition for GEM task workflows |
| plugins/gem-team/agents/gem-planner.md | Adds a planner agent definition producing DAG-based plan.yaml |
| plugins/gem-team/agents/gem-orchestrator.md | Adds an orchestrator agent definition coordinating GEM workflow phases |
| plugins/gem-team/agents/gem-implementer.md | Adds an implementer agent definition emphasizing TDD and verification |
| plugins/gem-team/agents/gem-documentation-writer.md | Adds a documentation writer agent definition for parity-maintained docs |
| plugins/gem-team/agents/gem-devops.md | Adds a DevOps agent definition with approval gates and health checks |
| plugins/gem-team/agents/gem-browser-tester.md | Adds a browser tester agent definition for Playwright-based validation |
| plugins/frontend-web-dev/commands/playwright-generate-test.md | Adds a Playwright MCP command for generating tests from scenarios |
| plugins/frontend-web-dev/commands/playwright-explore-website.md | Adds a Playwright MCP command for exploratory testing and test planning |
| plugins/devops-oncall/commands/multi-stage-dockerfile.md | Adds guidance for multi-stage Dockerfile creation |
| plugins/devops-oncall/agents/azure-principal-architect.md | Adds an Azure architecture guidance agent definition (DevOps oncall plugin) |
| plugins/dataverse-sdk-for-python/commands/dataverse-python-quickstart.md | Adds a Dataverse Python SDK quickstart generation command |
| plugins/dataverse-sdk-for-python/commands/dataverse-python-production-code.md | Adds a production-quality Dataverse Python SDK code generation command |
| plugins/dataverse-sdk-for-python/commands/dataverse-python-advanced-patterns.md | Adds advanced patterns guidance for Dataverse Python SDK usage |
| plugins/database-data-management/agents/postgresql-dba.md | Adds a PostgreSQL DBA agent definition constrained to DB tooling usage |
| plugins/database-data-management/agents/ms-sql-dba.md | Adds an MS SQL DBA agent definition constrained to DB tooling usage |
| plugins/csharp-mcp-development/commands/csharp-mcp-server-generator.md | Adds a command for generating a C# MCP server project outline |
| plugins/csharp-mcp-development/agents/csharp-mcp-expert.md | Adds an agent definition for C# MCP server development guidance |
| plugins/csharp-dotnet-development/commands/dotnet-upgrade.md | Adds .NET upgrade analysis prompt templates (currently YAML-like content) |
| plugins/csharp-dotnet-development/commands/dotnet-best-practices.md | Adds .NET/C# best practices guidance command content |
| plugins/csharp-dotnet-development/commands/csharp-xunit.md | Adds xUnit best practices guidance command content |
| plugins/csharp-dotnet-development/commands/csharp-tunit.md | Adds TUnit best practices guidance command content |
| plugins/csharp-dotnet-development/commands/csharp-nunit.md | Adds NUnit best practices guidance command content |
| plugins/csharp-dotnet-development/commands/csharp-async.md | Adds async best practices guidance command content |
| plugins/csharp-dotnet-development/commands/aspnet-minimal-api-openapi.md | Adds ASP.NET Minimal API + OpenAPI guidance command content |
| plugins/csharp-dotnet-development/agents/expert-dotnet-software-engineer.md | Adds an expert .NET engineering guidance agent definition |
| plugins/context-engineering/commands/what-context-needed.md | Adds a command template for requesting needed context before answering |
| plugins/context-engineering/commands/refactor-plan.md | Adds a multi-file refactor planning command template |
| plugins/context-engineering/commands/context-map.md | Adds a context mapping command template for multi-file changes |
| plugins/context-engineering/agents/context-architect.md | Adds an agent definition for dependency/context mapping before changes |
| plugins/clojure-interactive-programming/commands/remember-interactive-programming.md | Adds a micro-prompt for REPL-first interactive programming reminders |
| plugins/clojure-interactive-programming/agents/clojure-interactive-programming.md | Adds an agent definition enforcing REPL-first Clojure workflows |
| plugins/cast-imaging/agents/cast-imaging-structural-quality-advisor.md | Adds a CAST Imaging structural quality advisor agent definition |
| plugins/cast-imaging/agents/cast-imaging-software-discovery.md | Adds a CAST Imaging discovery agent definition |
| plugins/cast-imaging/agents/cast-imaging-impact-analysis.md | Adds a CAST Imaging impact analysis agent definition |
| plugins/azure-cloud-development/agents/terraform-azure-planning.md | Adds an Azure Terraform planning agent definition writing INFRA plans |
| plugins/azure-cloud-development/agents/terraform-azure-implement.md | Adds an Azure Terraform implementation agent definition with validation steps |
| plugins/azure-cloud-development/agents/azure-verified-modules-terraform.md | Adds guidance for using AVM Terraform modules and required checks |
| plugins/azure-cloud-development/agents/azure-verified-modules-bicep.md | Adds guidance for using AVM Bicep modules with best practices |
| plugins/azure-cloud-development/agents/azure-saas-architect.md | Adds an Azure SaaS architect guidance agent definition |
| plugins/azure-cloud-development/agents/azure-principal-architect.md | Adds an Azure principal architect guidance agent definition |
| plugins/azure-cloud-development/agents/azure-logic-apps-expert.md | Adds an Azure Logic Apps expert guidance agent definition |
| plugins/awesome-copilot/commands/suggest-awesome-github-copilot-skills.md | Adds a command to suggest skills from awesome-copilot and compare versions |
| plugins/awesome-copilot/commands/suggest-awesome-github-copilot-prompts.md | Adds a command to suggest prompts from awesome-copilot and compare versions |
| plugins/awesome-copilot/commands/suggest-awesome-github-copilot-instructions.md | Adds a command to suggest instructions from awesome-copilot and compare versions |
| plugins/awesome-copilot/commands/suggest-awesome-github-copilot-agents.md | Adds a command to suggest agents from awesome-copilot and compare versions |
| plugins/awesome-copilot/agents/meta-agentic-project-scaffold.md | Adds a meta “scaffold” agent referencing awesome-copilot assets |
| eng/constants.mjs | Injects “How to Contribute” copy into templates for each resource type |
| docs/README.workflows.md | Adds “How to Contribute” and replaces placeholder with a workflows table entry |
| docs/README.skills.md | Adds “How to Contribute” section linking to CONTRIBUTING skills guidance |
| docs/README.prompts.md | Adds “How to Contribute” section linking to CONTRIBUTING prompts guidance |
| docs/README.plugins.md | Adds “How to Contribute” section linking to CONTRIBUTING plugins guidance |
| docs/README.instructions.md | Adds “How to Contribute” section linking to CONTRIBUTING instructions guidance |
| docs/README.hooks.md | Adds “How to Contribute” section linking to CONTRIBUTING hooks guidance |
| docs/README.agents.md | Adds “How to Contribute” section linking to CONTRIBUTING agents guidance |
| SECURITY.md | Removes leading non-heading lines and keeps the Security doc content focused |
| CONTRIBUTING.md | Adds TOC, expands guidance (hooks), and aligns workflow frontmatter guidance |
| AGENTS.md | Removes outdated workflow fields and updates spec link to reference structure |
| .github/aw/actions-lock.json | Adds additional pinned action entries for the agentic workflow toolchain |
plugins/frontend-web-dev/commands/playwright-explore-website.md
Outdated
Show resolved
Hide resolved
9d317e4 to
e822326
Compare
…s, hooks, instructions, plugins, skills, and workflows; enhance actions-lock.json with additional actions
e822326 to
6103b17
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (1)
CONTRIBUTING.md:249
- The workflow example configures
safe-outputs.create-issuebut setspermissions.issues: read. Creating an issue requiresissues: write, so contributors following this example will end up with a non-working workflow.
name: "Daily Issues Report"
description: "Generates a daily summary of open issues and recent activity as a GitHub issue"
on:
schedule: daily on weekdays
permissions:
contents: read
issues: read
safe-outputs:
create-issue:
title-prefix: "[daily-report] "
labels: [report]
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
@aaronpowell for your review |
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.
Summary
This PR improves documentation consistency and discoverability across the repository.
Changes
CONTRIBUTING.md:
triggers/tagsfields), linked to an existing workflow fileAGENTS.md:
triggersandtagsfield references from workflow documentation (spec section, adding resources steps, and code review checklist)on,permissions,safe-outputs)eng/constants.mjs:
### How to Contributesections with links to CONTRIBUTING.md before each### How to Useblock for all resource types (instructions, prompts, agents, skills, hooks, plugins, workflows)docs/README.*.md (generated):