Skip to content

Latest commit

 

History

History
66 lines (35 loc) · 1.69 KB

contributing.md

File metadata and controls

66 lines (35 loc) · 1.69 KB
Raw

Contributing to EDM4hep

Please read these guidelines if you want to contribute to the EDM4hep project.

Git workflow

For EDM4hep we would like to follow a so called "No Switch Yard" (NoSY) workflow.

In essence this means that you develop your (small) new feature in a dedicated feature branch that is kept up to date with the master branch until you create a PR, as we only allow rebase merges for PRs.

Example workflow

  • checkout a copy of EDM4hep from the origin at Key4HEP:

    git clone https://github.com/key4hep/EDM4HEP.git cd EDM4HEP

  • create a fork of the repository on the Github web page

    • if you have not yet done so earlier

  • add your fork as remote downstream using your Github username

    git remote add downstream  https://<yourUserName>@github.com/<yourUserName>/EDM4HEP.git

  • create a new feature branch; choose a meaningful name

    git checkout -b <myNewBranch>

  • make the changes to existing files (or add new ones) and frequently keep up to date with the master:

    git fetch origin; git rebase origin/master

  • after having committed everything to your new branch, push it to your fork of EDM4hep:

    git push downstream <myNewBranch>

  • reload your own Github website (https://github.com//EDM4HEP)

    • you should see your commit
    • now you can create a pull request on the web site

Release Notes

Please make sure you fill in meaningful release notes in the comment field that is provided at the Github web page when creating the PR, e.g.


BEGINRELEASENOTES
- updated documentation
    - add guidelines for contributing
- reverted some name changes in tests/examples
    - `read-one` now again called `read`

ENDRELEASENOTES