Skip to content

Latest commit

 

History

History
40 lines (34 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

40 lines (34 loc) · 1.88 KB
Raw

Contributions are always welcome!

Did you find a bug?

  • Ensure the bug was not already reported by searching the open issues of this repository.
  • Check the closed issues for solutions to problems other users had.
  • If you're unable to find an issue addressing your problem, open a new issue.
  • Be sure to include a clear title and a clear description, log files, screenshots and/or code samples so that we can understand and reproduce the problem.

Do you want to contribute code?

Thanks for your interest in contributing. Anybody is free to propose any changes to this repository using Merge Requests. We appreciate every Merge Request, but merging cannot be guaranteed. Before you submit your code, please check the following prerequisites:

  • use git to manage your changes [recommended]
  • please follow common code conventions
  • add the required copyright header to each new file introduced, see licensing information [required]
  • structure patches logically, in small steps [required]
    • one separable functionality/fix/refactoring = one patch
    • do not mix those three into a single patch (e.g. first refactor, then add a new functionality that builds onto the refactoring)
    • after each patch, the tree still has to build and work, i.e. do not add even temporary breakages inside a patch series (helps when tracking down bugs)
    • use git rebase -i to restructure a patch series
  • test patches sufficiently (obvious, but...) [required]
  • after creating a Pull Request: if you haven't signed the Siemens Contributor License Agreement (CLA) in the past, you'll be automatically asked as part of your PR to sign it online at the specified URL. After you've signed the CLA, your PR will automatically be cleared for merging if all other test stages succeed.

Thank you!