Skip to content

Commit

Permalink
Added contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
Juanki0396 committed Oct 1, 2024
1 parent 086d38b commit 7439597
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,22 @@ be used:
k4_local_repo
```

## How to contribute

In order to make contributions to the project, you should work on your own fork of the project. It
is important that you keep yout fork updated with the originial repo. An easy way to do it is configure
a remote with the original repo and rebase often to keep you updated:

```
git remote add official https://github.com/HEP-FCC/ral.git
git fetch official
git rebase -i offcial/main
```

Once your changes are ready and your fork is synced with the original repo, you can
open a pull request on github to ask for a merge. Don't forget to pass the tests
and format your code with clang-format.

## Interactive use

In order to use this library inside ROOT REPL one can open a root file with
Expand Down

0 comments on commit 7439597

Please sign in to comment.