2016-09-14 04:31:49 +02:00
|
|
|
# Contribution guidelines
|
|
|
|
|
|
2023-09-07 13:23:13 +02:00
|
|
|
<!--
|
|
|
|
|
SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
|
|
|
|
|
SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
-->
|
2018-07-03 09:47:11 +02:00
|
|
|
|
2023-09-07 13:23:13 +02:00
|
|
|
## Coding standards
|
2018-07-03 09:47:11 +02:00
|
|
|
|
2023-09-07 13:23:13 +02:00
|
|
|
We are following the [LLVM C++ Coding Standards](https://llvm.org/docs/CodingStandards.html).
|
2018-07-03 09:47:11 +02:00
|
|
|
|
|
|
|
|
## Always work on feature branches
|
2016-09-14 04:31:49 +02:00
|
|
|
|
2023-09-07 13:23:13 +02:00
|
|
|
Please branch from `master` to create a new _feature_ branch.
|
2016-09-14 04:31:49 +02:00
|
|
|
|
|
|
|
|
Please create a new _feature_ branch for every new feature or fix.
|
|
|
|
|
|
2023-09-07 13:23:13 +02:00
|
|
|
## Do not commit directly to `master`.
|
2016-09-14 04:31:49 +02:00
|
|
|
|
|
|
|
|
Use your _feature_ branch.
|
|
|
|
|
|
|
|
|
|
Please rebase your work against the `develop` before submitting a merge reqeuest.
|
|
|
|
|
|
2018-07-03 09:47:11 +02:00
|
|
|
## Make the CI happy :-)
|
2016-09-14 04:31:49 +02:00
|
|
|
|
|
|
|
|
Only branches which pass the CI can be merged.
|
