From 108d0394e69a826cdbf67a1c5e1d10280a5f369d Mon Sep 17 00:00:00 2001 From: "Mayr, Hannes" <hannes.mayr@stud.tu-darmstadt.de> Date: Mon, 21 Nov 2022 16:37:56 +0100 Subject: [PATCH] Introduce Citation.cff and mention black code style in Contributing.md. --- CITATION.cff | 19 +++++++++++++++++++ CONTRIBUTING.md | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..4573bfc --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,19 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +type: software +title: plotID +authors: + - family-names: Mayr + given-names: Hannes + email: hannes.mayr@stud.tu-darmstadt.de + affiliation: Institut für Fluidsystemtechnik - TU Darmstadt + - family-names: Hock + given-names: Martin + email: Martin.Hock@fst.tu-darmstadt.de + affiliation: Institut für Fluidsystemtechnik - TU Darmstadt + orcid: https://orcid.org/0000-0001-9917-3152 + - family-names: Richter + given-names: Manuela + email: Manuela.Richter@fst.tu-darmstadt.de + affiliation: Institut für Fluidsystemtechnik - TU Darmstadt + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 301dcff..aa3acb6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Feel free to **report** all **issues** you encounter with plotID in our [issue tracker](https://git.rwth-aachen.de/plotid/plotid_python/-/issues). This will greatly help to improve plotID. -Contributing to plotID via **merge requests** is also highly appreciated. Please make sure that your code complies with the [PEP 8 - Style Guide](https://peps.python.org/pep-0008/) before creating a merge request. We try to have the whole code of plotID covered by unittests. So if you contribute new code to plotid please also provide unittests that cover the new functionality. Should you be interested in adding another plot engine to be supported by plotID, have a look at the section [Implement a new plot engine](#add-plot-engine). There are some hints how to proceed in this case. +Contributing to plotID via **merge requests** is also highly appreciated. Please make sure that your code complies with the [PEP 8 - Style Guide](https://peps.python.org/pep-0008/) before creating a merge request. We enforce the [**black code style**](https://black.readthedocs.io/en/stable/). We try to have the whole code of plotID covered by unittests. So if you contribute new code to plotid please also provide unittests that cover the new functionality. Should you be interested in adding another plot engine to be supported by plotID, have a look at the section [Implement a new plot engine](#add-plot-engine). There are some hints how to proceed in this case. ## Setup development environment Clone the repository and install the dependencies: -- GitLab