Mirrors/VILLASnode
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
Code Issues Releases Wiki Activity

contributing: add reference to contributing guidelines in documentation

Browse source 
replaces current CONTRIBUTING.md with reference to documentation and adds a section in README.md referencing the same.

Signed-off-by: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
This commit is contained in:
Niklas Eiling 2024-11-15 09:18:07 +00:00 • committed by Niklas Eiling
parent 26e6d69bfe
commit 18791fe90f
2 changed files with 7 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -1,26 +1,8 @@
# Contribution guidelines
<!--
SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
SPDX-FileCopyrightText: 2014-2024 Institute for Automation of Complex Power Systems, RWTH Aachen University
SPDX-License-Identifier: Apache-2.0
-->
## Coding standards
We are following the [LLVM C++ Coding Standards](https://llvm.org/docs/CodingStandards.html).
## Always work on feature branches
Please branch from `master` to create a new _feature_ branch.
Please create a new _feature_ branch for every new feature or fix.
## Do not commit directly to `master`.
Use your _feature_ branch.
Please rebase your work against the `develop` before submitting a merge reqeuest.
## Make the CI happy :-)
Only branches which pass the CI can be merged.
Visit the [contribution guidelines](https://villas.fein-aachen.org/docs/node/development/contributing/) in our documentation to understand how you can contribute to VILLASnode.

5
README.md
View file

@ -36,6 +36,11 @@ User documentation is available here: <https://villas.fein-aachen.org/docs/>
- [MIOB](https://github.com/RWTH-ACS/miob)
- [DINO](https://github.com/RWTH-ACS/dino)
## Contributing
All contributions are welcome!
If you want to contribute to VILLASnode, please visit the [contribution guidelines](https://villas.fein-aachen.org/docs/node/development/contributing/) in our documentation.
## License
This project is released under the terms of the [Apache 2.0 license](LICENSE).