Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Draft contributor documentation #557

@jrschumacher

Description

@jrschumacher

Feature/Task: Agent-Guided Development and Documentation

I would like to leverage GitHub Copilot Agents to guide the development and documentation of this feature, following a structured process:

1. Code Assessment (Architect Agent)

  • Assess the relevant codebase for this feature.
  • Identify architecture, dependencies, and possible challenges.
  • Summarize findings and recommend an implementation plan, including:
    • Components/modules to modify or create
    • Suggested architecture/design patterns
    • Risk areas and mitigations
    • Required tests or validation steps

2. Implementation Plan (Architect Agent)

  • Provide a detailed, step-by-step implementation plan based on the assessment.
  • Break work into logical, manageable tasks or PRs.
  • List prerequisites or task dependencies.

3. Documentation (Documenter Agent)

  • Once development is underway or complete, generate comprehensive documentation:
    • Overview of the feature and its purpose
    • Technical details and architecture diagrams (if applicable)
    • Usage examples and configuration/setup instructions
    • Testing and validation instructions
    • Known limitations or future work

4. Iteration

  • Iterate on the plan and docs as needed, incorporating feedback and refining deliverables.

Please start with a code assessment and proposed implementation plan from the Architect Agent. After agreement on the plan, engage the Documenter Agent to produce and refine documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions