Skip to content

Commit 33b5357

Browse files
committed
Add more details and links in contribution instructions
1 parent 3bcae91 commit 33b5357

File tree

3 files changed

+28
-6
lines changed

3 files changed

+28
-6
lines changed

docs/gettingstarted/contributingtocode.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Before starting to write your first piece of code, please get familiar with the
1919
and also check for more detailed instructions from your [PWG](../advanced-specifics/README.md).
2020
```
2121

22+
```tip
23+
See the [Tools](../tools/README.md) section for suggestions on tools that can make your work with the O2Physics analysis framework much more effective.
24+
```
25+
2226
In order to contribute new code to the central repository, please follow these steps:
2327

2428
- If you are adding a new workflow:
@@ -66,17 +70,34 @@ __Give your pull request a short and meaningful title.__
6670

6771
### Automatic checks
6872

69-
Pull requests are tested with automatic checks which get restarted whenever the commits in the PR change.
73+
Pull requests are tested with automatic continuous-integration (CI) checks which get restarted whenever the commits in the PR change.
74+
75+
The CI checks evaluate:
76+
77+
- Code formatting
78+
- Code quality
79+
- [MegaLinter](https://megalinter.io/)
80+
- [O2 linter](../tools/o2linter.md)
81+
- Compilation: Verifies that the code compiles without problems on all supported platforms.
82+
- PR properties
83+
- Labeler: Assigns [labels](https://github.com/AliceO2Group/O2Physics/labels) to the PR based on which parts of the code base were modified.
84+
- Title prefix checker: Verifies that the title of the PR has a valid prefix with tags corresponding to the labels. If a valid prefix is not found, it is created.
85+
86+
Checks flagged as "Required" must succeed before a PR can be merged.
87+
7088
The compilation checks ("build/...") run only on PRs marked as ready for review (i.e. not on draft PRs).
7189
PRs from first-time contributors (who have not authored any commit in the repository yet) require an approval to start the compilation checks.
7290

73-
If a check fails, you can click on "Details" to see more information about the errors in the log of the test.
91+
If a check fails, you can click on the name of the check to see more information about the errors in the log of the test.
7492

7593
If the clang-format check (or a formatting linter in MegaLinter) fails, an automatic PR with the formatting fixes is opened in your fork and a notification email is sent to you.
7694
You have to merge this formatting PR to update your branch (and your opened PR).
7795

78-
```note
79-
This means that _you do not have to format your (C++ and Python) code_, as the automatic formatting check does that for you.
96+
```tip
97+
_You do not have to format your (C++ and Python) code manually_.
98+
99+
- You can let your PR get formatted by the automatic formatting check.
100+
- Or you can use [pre-commit hooks](../tools/README.md#pre-commit-hooks) to format your code automatically when you make a commit.
80101
```
81102

82103
### Pull request review

docs/tools/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This helps to apply the [Include What You Use](https://github.com/AliceO2Group/O
6767

6868
#### Sorting `#include`s
6969

70-
The [`llvm-include-order`](https://clang.llvm.org/extra/clang-tidy/checks/llvm/include-order.html) check sorts `#include`s from most specific to least specific to ensure that the headers does not have any hidden dependencies.
70+
The [`llvm-include-order`](https://clang.llvm.org/extra/clang-tidy/checks/llvm/include-order.html) check sorts `#include`s from most specific to least specific to ensure that the headers do not have any hidden dependencies.
7171

7272
Unfortunately, the [LLVM include style](https://llvm.org/docs/CodingStandards.html#include-style) is incompatible with the [Google include style](https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes) applied by `cpplint`.
7373

docs/troubleshooting/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ If the missing table is not mentioned there, try to find the missing workflow fo
107107
| Old | New | Converter |
108108
|--------------------------------|-------------------|-------------------------------------------|
109109
| `bc` | `bc_001` | `o2-analysis-bc-converter` |
110+
| `run2bcinfo` | `run2bcinfo_001` | `o2-analysis-run2bcinfos-converter` |
110111
| `collision` | `collision_001` | `o2-analysis-collision-converter` |
111112
| `fdd` | `fdd_001` | `o2-analysis-fdd-converter` |
112113
| `hmpid` | `hmpid_001` | `o2-analysis-hmpid-converter` |
@@ -122,7 +123,7 @@ If the missing table is not mentioned there, try to find the missing workflow fo
122123

123124
#### General cases
124125

125-
You can identify the missing workflow by running the [`find_dependencies.py`](https://github.com/AliceO2Group/O2Physics/blob/master/Scripts/find_dependencies.py) script.
126+
You can identify the missing workflow by running the [dependency finder](../tools/dependencyFinder.md).
126127
The procedure is simple: If the error message complains about a missing table `DF_<id>/O2<table>` then you have to run `$O2PHYSICS_ROOT/share/scripts/find_dependencies.py -t <table>`
127128
inside the O2Physics environment and add the correct one among the listed producer workflows to your command line.
128129

0 commit comments

Comments
 (0)