From de305a5333c4fcaad316af1ea8c11279c06ad1cf Mon Sep 17 00:00:00 2001 From: Niklas Eiling Date: Fri, 15 Nov 2024 09:18:07 +0000 Subject: [PATCH] contributing: add reference to contributing guidelines in documentation replaces current CONTRIBUTING.md with reference to documentation and adds a section in README.md referencing the same. Signed-off-by: Niklas Eiling --- CONTRIBUTING.md | 22 ++-------------------- README.md | 5 +++++ 2 files changed, 7 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3106b0570..18ca39b4c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,26 +1,8 @@ # Contribution guidelines -## 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. diff --git a/README.md b/README.md index d67a05792..843860570 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,11 @@ User documentation is available here: - [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).