Skip to content
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

Added contribution guidelines #25

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Added contribution guidelines #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
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
Loading