Contributing

Key4hep is an open source project, and we welcome contributions of all kinds:

  • New lessons

  • Fixes to existing material

  • Bug reports

  • Reviews of proposed changes

By contributing, you are agreeing that we may redistribute your work under these licenses. You also agree to abide by our contributor code of conduct.

Getting Started

  1. We use the fork and pull model to manage changes. More information about forking a repository and making a Pull Request.

  2. You should branch from and submit pull requests against the main branch (in some repositories it may still be master but this will change in the future to main).

  3. If you’re looking for things to work on, feel free to get in touch with the Key4hep team at key4hep dash sw @ cern dot ch. You can also have a look at the the list of issues for this repository. Comments on issues and reviews of pull requests are equally welcome.

Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behaviour by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at https://contributor-covenant.org/version/1/0/0/.