Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/agents/Reviewer.agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Reviewer
description: Review code for quality and adherence to best practices.
argument-hint: The inputs this agent expects, e.g., "a task to implement" or "a question to answer".
tools: ['vscode/askQuestions', 'vscode/vscodeAPI' 'read', 'agent', 'search', 'web'] # specify the tools this agent can use. If not set, all enabled tools are allowed.
---

# Code Reviewer agent

You are an experienced senior developer conducting a thorough code review. Your role is to review
the code for quality, best practices, and adherence to [project standards](../copilot-instructions.md)
without making direct code changes.

When reviewing code, structure your feedback with clear headings and specific examples from the
code being reviewed.

## Analysis Focus

- Analyze code quality, structure, and best practices
- Identify potential bugs, security issues, or performance problems
- Evaluate accessibility and user experience considerations

## Important Guidelines

- Ask clarifying questions about design decisions when appropriate
- Focus on explaining what should be changed and why
- DO NOT write or suggest specific code changes directly
33 changes: 33 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Project general coding guidelines

This project implements a comprehensive a Python tool to create and manage
SBOMs and to interact with SW360. The project is structured into multiple modules,
each responsible for specific functionalities such as SBOM generation, SW360 interaction,
and command-line interface (CLI) management.

## General

- Use `poetry` to manage the project.
- Use `requests` for HTTP communication.
- Use `pytest` for unit testing.
- Use `responses` for mocking HTTP requests.

## Code Style

- use `flake8`
- use `isort`
- use type hints
- use `requests` for HTTP communication

## Naming Conventions

- Follow PEP 8 naming conventions
- Use ALL_CAPS for constants

## Code Quality

- Use meaningful variable and function names that clearly describe their purpose
- Include helpful comments for complex logic
- Add error handling for user inputs and API calls
- Use type hints throughout the codebase for better IDE support
- Include docstrings for all public methods
37 changes: 37 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# AGENTS.md

This project implements a comprehensive a Python tool to create and manage
SBOMs and to interact with SW360. The project is structured into multiple modules,
each responsible for specific functionalities such as SBOM generation, SW360 interaction,
and command-line interface (CLI) management.

## General

- Use `poetry` to manage the project.
- Use `requests` for HTTP communication.
- Use `pytest` for unit testing.
- Use `responses` for mocking HTTP requests.

## Code Style

- use `flake8`
- use `isort`
- use type hints
- use `requests` for HTTP communication

## Naming Conventions

- Follow PEP 8 naming conventions
- Use ALL_CAPS for constants

## Code Quality

- Use meaningful variable and function names that clearly describe their purpose
- Include helpful comments for complex logic
- Add error handling for user inputs and API calls
- Use type hints throughout the codebase for better IDE support
- Include docstrings for all public methods

## PR instructions

- Title format: [<project_name>] Title
Loading
Loading