Skip to content

key4hep/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 

Repository files navigation

Contribution Guidelines for Key4hep Packages

Pull Requests

When making a Pull Request please explain what and why things were changed. Please include a short description in the BEGINRELEASENOTES/ENDRELEASENOTES block, which will appear in the doc/ReleaseNotes.md, once a new tag is made.

While we welcome all contributions big or small, you must be able to understand all changes done in the code yourself. That means in particular any change provided by an LLM or similar tool must be thoroughly reviewed by yourself. Also please understand that it might take some time to properly review your PR as the time of the maintainers is a limited resource.

We are happy if you create pull-requests also if you feature is not ready, yet. Please mark them as such by adding [WIP] to the start of the title and create a Draft pull request. The purpose of this is, for example, that you want to let other people know you are working on a given issue. For these work-in-progress pull-request, we propose to have a check list of things that still need to be done.

Issue tracking

Use the GitHub issue tracker. Reference the issues that you are working on. If you notice an issue, consider first creating an issue and then refering to it in your pull-request and commit messages with #[issue-id].

Coding Conventions

  • Your code should not introduce any new warnings, and fix as many existing warnings as possible

Git workflow

Please rebase your feature branches instead of merging from upstream. Use sensible commit messages and check the spelling in them.

About

Default Issue and PR templates

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors