Skip to content

Commit 4e36fac

Browse files
authored
Add Copilot agent instructions (#744)
1 parent ce2ca52 commit 4e36fac

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

.github/copilot-instructions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## ALICE Experiment Control System (AliECS)
2+
3+
The ALICE Experiment Control System (**AliECS**) is the piece of software to drive and control data taking activities in the experiment.
4+
It is a distributed system that combines state of the art cluster resource management and experiment control functionalities into a single comprehensive solution.
5+
6+
### Copilot agent instructions
7+
8+
- Running `make` in the main directory lets you build all golang components of AliECS.
9+
- Running `make test` in the main directory lets you run all golang tests of AliECS.
10+
- Do not attempt to build C++ components unless you already have access to their dependencies (FairMQ and FairLogger) and the task requires you to do it.
11+
- When changing API interfaces, run `make docs` to regenerate the API documentation.
12+
- When changing gRPC interfaces and proto files, run `make generate` to regenerate the gRPC code.
13+
- Do not include regenerated Go files in your commits unless you are changing the API or proto files. If you do, include only the files which are related to your task.
14+
- Do not include modified go.mod and go.sum files in your commits unless you are adding or upgrading a dependency.
15+
- When adding features or fixing bugs, add a corresponding unit test if feasible. Use Ginkgo/Gomega, unless a package already uses a different testing framework.
16+
- When adding a new feature, extend the documentation accordingly, follow the existing style and structure, and make sure that Tables of Contents are updated. See [Documentation guidelines](docs/CONTRIBUTING.md#documentation-guidelines) for some more details.
17+
- When providing a fix, explain what was causing the issue and how it was fixed.

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Gomega/Ginkgo tests are preferred, but other style of tests are also welcome.
5151
## Documentation guidelines
5252

5353
The markdown documentation is aimed to be browsed on GitHub, but it also on the aggregated [FLP documentation](https://alice-flp.docs.cern.ch) based on [MkDocs](https://www.mkdocs.org/).
54-
Consequently, any changes in the documentation structure should be reflected in the Table of Contents in the main README.md, as well as `mkdocs.yml` and `mkdocs.yml`.
54+
Consequently, any changes in the documentation structure should be reflected in the Table of Contents in the main README.md, as well as `mkdocs.yml` and `mkdocs-dev.yml`.
5555

5656
The AliECS MkDocs documentation is split into two aforementioned files to follow the split between "Products" and "Developers" tabs in the FLP documentation.
5757
The `mkdocs-dev.yml` uses a symlink `aliecs-dev` to `aliecs` directory to avoid complaints about duplicated site names.

0 commit comments

Comments
 (0)