Skip to content

Commit 2de88e1

Browse files
committed
chores: have instruction files for the AI
1 parent 5ec20ed commit 2de88e1

3 files changed

Lines changed: 95 additions & 0 deletions

File tree

.github/agents/Reviewer.agent.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Reviewer
3+
description: Review code for quality and adherence to best practices.
4+
argument-hint: The inputs this agent expects, e.g., "a task to implement" or "a question to answer".
5+
tools: ['vscode/askQuestions', 'vscode/vscodeAPI' 'read', 'agent', 'search', 'web'] # specify the tools this agent can use. If not set, all enabled tools are allowed.
6+
---
7+
8+
# Code Reviewer agent
9+
10+
You are an experienced senior developer conducting a thorough code review. Your role is to review
11+
the code for quality, best practices, and adherence to [project standards](../copilot-instructions.md)
12+
without making direct code changes.
13+
14+
When reviewing code, structure your feedback with clear headings and specific examples from the
15+
code being reviewed.
16+
17+
## Analysis Focus
18+
19+
- Analyze code quality, structure, and best practices
20+
- Identify potential bugs, security issues, or performance problems
21+
- Evaluate accessibility and user experience considerations
22+
23+
## Important Guidelines
24+
25+
- Ask clarifying questions about design decisions when appropriate
26+
- Focus on explaining what should be changed and why
27+
- DO NOT write or suggest specific code changes directly

.github/copilot-instructions.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Project general coding guidelines
2+
3+
This project is a Python library that implements the REST API for SW360, an
4+
open-source enterprise component management system developed by the Eclipse
5+
Foundation.
6+
7+
## General
8+
9+
- Use `poetry` to manage the project.
10+
- Use `requests` for HTTP communication.
11+
- Use `pytest` for unit testing.
12+
- Use `responses` for mocking HTTP requests.
13+
14+
## Code Style
15+
16+
- use `flake8`
17+
- use `isort`
18+
- use type hints
19+
- use `requests` for HTTP communication
20+
21+
## Naming Conventions
22+
23+
- Follow PEP 8 naming conventions
24+
- Use ALL_CAPS for constants
25+
26+
## Code Quality
27+
28+
- Use meaningful variable and function names that clearly describe their purpose
29+
- Include helpful comments for complex logic
30+
- Add error handling for user inputs and API calls
31+
- Use type hints throughout the codebase for better IDE support
32+
- Include docstrings for all public methods

AGENTS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# AGENTS.md
2+
3+
This project is a Python library that implements the REST API for SW360, an
4+
open-source enterprise component management system developed by the Eclipse
5+
Foundation.
6+
7+
## General
8+
9+
- Use `poetry` to manage the project.
10+
- Use `requests` for HTTP communication.
11+
- Use `pytest` for unit testing.
12+
- Use `responses` for mocking HTTP requests.
13+
14+
## Code Style
15+
16+
- use `flake8`
17+
- use `isort`
18+
- use type hints
19+
- use `requests` for HTTP communication
20+
21+
## Naming Conventions
22+
23+
- Follow PEP 8 naming conventions
24+
- Use ALL_CAPS for constants
25+
26+
## Code Quality
27+
28+
- Use meaningful variable and function names that clearly describe their purpose
29+
- Include helpful comments for complex logic
30+
- Add error handling for user inputs and API calls
31+
- Use type hints throughout the codebase for better IDE support
32+
- Include docstrings for all public methods
33+
34+
## PR instructions
35+
36+
- Title format: [<project_name>] Title

0 commit comments

Comments
 (0)