Skip to content

docs(CONTRIBUTING): Proposed updates to Contributing Guidelines #1629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rlalik wants to merge 2 commits into
base: dev
Choose a base branch
from
+27 −4
Draft

docs(CONTRIBUTING): Proposed updates to Contributing Guidelines #1629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcdb541
docs(CONTRIBUTING): Proposed updates to Contributing Guidelines
rlalik Mar 29, 2026
c005077
docs(CONTRIBUTORS): Update contributor records
rlalik Mar 28, 2026
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
5 changes: 5 additions & 0 deletions .zenodo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@
"type": "Other",
"name": "Krzewicki, Mikolaj"
},
{
"type": "Other",
"name": "Lalik, Rafa\u0142",
"orcid": "0000-0003-1313-3729"
},
{
"type": "Other",
"name": "Lavezzi, Lia"
Expand Down
19 changes: 15 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ Create a [Github Pull Request](https://github.com/FairRootGroup/FairRoot/compare
* In rare cases (e.g. backports, some hotfixes) base against the appropriate
branch.
2. If you are a first time contributor, add a separate commit in your PR which
adds your name to the [`CONTRIBUTORS`](CONTRIBUTORS) file.
adds your name to the:
* [`CONTRIBUTORS`](CONTRIBUTORS) file,
* [`.zenodo.json`](.zenodo.json) file, and
* [`codemeta.json`](codemeta.json) file.
Comment on lines -16 to +19
Copy link
Copy Markdown
Member

@dennisklein dennisklein Mar 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CONTRIBUTORS is the authoritative place to add new names. Maintainers will then run meta_update.py (ref N.4)

Copy link
Copy Markdown
Author

@rlalik rlalik Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, ok, from this comment I got impression that I should do it by myself: #1628 (comment)
I'll restore older version to this part.

3. Follow our [Coding Guidelines](#coding-guidelines).
4. Expect that a reviewer will ask you for restructuring your commits! This
usually happens towards the end of the lifetime of a PR when it matured
Expand Down Expand Up @@ -53,7 +56,15 @@ This shall be an evolving list of explicitely adopted C++ Core Guidelines:
* If an owning raw pointer cannot be avoided for legacy reasons,
**you must add a comment documenting the ownership semantics!**

### G.3 Write a good Git history
### G.3 Other C++ Guidelines

1. Use of ROOT types:
1. The data which are intended to be stored in the ROOT files should use ROOT data type.
2. Variables which control execution logic should use standard types.

## V - Version control

### V.1 Write a good Git history

* Follow [the seven rules of a great Git commit message](https://cbea.ms/git-commit/#seven-rules)!
* Use a meaningful commit granularity, e.g. do not mix
Expand All @@ -65,15 +76,15 @@ This shall be an evolving list of explicitely adopted C++ Core Guidelines:
* Utilize [reference keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
both in commit messages as well as in PR comments if applicable.

### G.4 Conventional Commits
### V.2 Conventional Commits

* Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
* Adopted `type`s: `fix:`, `feat:`, `build:`, `chore:`, `ci:`, `docs:`,
`style:`, `refactor:`, `perf:`, `test:`
* If a `scope` is used, prefer the library name (first directory level below
`fairroot/`), e.g. `fix(base):` or `feat(geobase):`

### G.5 Signed Commits and Tags
### V.3 Signed Commits and Tags

You may use any signature format Git and Github support (SSH e.g. may be more
convenient, if one does not have a GPG key yet).
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Klenze, Philipp
Kollegger, Thorsten
Koenig, Ilse
Krzewicki, Mikolaj
Lalik, Rafał [https://orcid.org/0000-0003-1313-3729]
Lavezzi, Lia
Lavrik, Evgeny
Lantwin, Oliver
Expand Down
6 changes: 6 additions & 0 deletions codemeta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@
"givenName": "Mikolaj",
"familyName": "Krzewicki"
},
{
"@type": "Person",
"@id": "https://orcid.org/0000-0003-1313-3729",
"givenName": "Rafa\u0142",
"familyName": "Lalik"
},
{
"@type": "Person",
"givenName": "Lia",
Expand Down