Skip to content

Commit bcdb541

Browse files
committed
docs(CONTRIBUTING): Proposed updates to Contributing Guidelines
1 parent e22c961 commit bcdb541

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ Create a [Github Pull Request](https://github.com/FairRootGroup/FairRoot/compare
1313
* In rare cases (e.g. backports, some hotfixes) base against the appropriate
1414
branch.
1515
2. If you are a first time contributor, add a separate commit in your PR which
16-
adds your name to the [`CONTRIBUTORS`](CONTRIBUTORS) file.
16+
adds your name to the:
17+
* [`CONTRIBUTORS`](CONTRIBUTORS) file,
18+
* [`.zenodo.json`](.zenodo.json) file, and
19+
* [`codemeta.json`](codemeta.json) file.
1720
3. Follow our [Coding Guidelines](#coding-guidelines).
1821
4. Expect that a reviewer will ask you for restructuring your commits! This
1922
usually happens towards the end of the lifetime of a PR when it matured
@@ -53,7 +56,15 @@ This shall be an evolving list of explicitely adopted C++ Core Guidelines:
5356
* If an owning raw pointer cannot be avoided for legacy reasons,
5457
**you must add a comment documenting the ownership semantics!**
5558

56-
### G.3 Write a good Git history
59+
### G.3 Other C++ Guidelines
60+
61+
1. Use of ROOT types:
62+
1. The data which are intended to be stored in the ROOT files should use ROOT data type.
63+
2. Variables which control execution logic should use standard types.
64+
65+
## V - Version control
66+
67+
### V.1 Write a good Git history
5768

5869
* Follow [the seven rules of a great Git commit message](https://cbea.ms/git-commit/#seven-rules)!
5970
* Use a meaningful commit granularity, e.g. do not mix
@@ -65,15 +76,15 @@ This shall be an evolving list of explicitely adopted C++ Core Guidelines:
6576
* 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)
6677
both in commit messages as well as in PR comments if applicable.
6778

68-
### G.4 Conventional Commits
79+
### V.2 Conventional Commits
6980

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

76-
### G.5 Signed Commits and Tags
87+
### V.3 Signed Commits and Tags
7788

7889
You may use any signature format Git and Github support (SSH e.g. may be more
7990
convenient, if one does not have a GPG key yet).

0 commit comments

Comments
 (0)