Skip to content

Commit 468b012

Browse files
committed
Add Copilot agent instructions
1 parent ab4312f commit 468b012

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

.github/copilot-instructions.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## ALICE data Quality Control framework and Modules
2+
3+
This repository contains the ALICE O<sup>2</sup> data Quality Control (QC) framework and modules.
4+
It is divided into `Framework`, maintained by the framework developers and `Modules`, which are mostly developed by detector experts.
5+
6+
### Copilot agent instructions
7+
8+
- All the code should apply the [ALICE O2 Coding Guidelines](https://github.com/AliceO2Group/CodingGuidelines).
9+
See [Formatting tool](https://github.com/AliceO2Group/CodingGuidelines?tab=readme-ov-file#formatting-tool) for details how to set up code formatter.
10+
Do not attempt to install `clang` with `aliBuild`, use the one you have available on your system.
11+
- Unless you are running on a developer's machine and you were provided specific instructions, do not attempt to build the code or run tests. Quality Control uses a large number of external dependencies, which are not available in the default Copilot environment on GitHub.
12+
- When working on the C++ code-base, use the C++20 standard.
13+
- When modifying class definitions for which a ROOT dictionary is generated, remember to update their version in macros such as `ClassDefOverride` (e.g. `ClassDefOverride(MonitorObject, 15)` -> `ClassDefOverride(MonitorObject, 16)`).
14+
- Avoid changes which are not relevant to the current task.
15+
- When adding a new feature, write a unit test if feasible. Unit tests should use catch2.
16+
- When adding a new feature, extend the documentation accordingly and make sure that Tables of Contents are updated.
17+
- When providing a fix, explain what was causing the issue and how it was fixed.
18+
- When adding new code, make sure that necessary headers are included. Likewise, when removing code, remove the corresponding headers if they are not needed anymore.
19+
- When dealing with the code in `Modules`, prefer minimal changes which do not break the existing functionality.

0 commit comments

Comments
 (0)