From 03b6aa204b5797826b9a9167c834f6a1f4215be4 Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Fri, 14 Mar 2025 07:15:03 +0100 Subject: [PATCH 1/5] Add CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..12fe49f3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +## How to contribute to this project + +### Casual contributors + +#### Create issues +1. mention the version number of the package +1. write at least one sentence describing the issue +1. share the output of `versioninfo()` +1. indicate if it is a bug report or feature request + +### Regular contributors +1. become member of the Telegram channel +1. ask for write access + +#### Creating pull requests +1. create a new branch +1. push your changes to the branch +1. create a draft pull request +1. when you think it is ready, mark it as "ready for review" and invite a reviewer \ No newline at end of file From b9f32da2f311db4e3c52ae435e2dcb2288af116f Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Fri, 14 Mar 2025 07:27:41 +0100 Subject: [PATCH 2/5] More content --- CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12fe49f3..c8238483 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,4 +16,19 @@ 1. create a new branch 1. push your changes to the branch 1. create a draft pull request -1. when you think it is ready, mark it as "ready for review" and invite a reviewer \ No newline at end of file +1. when you think it is ready, mark it as "ready for review" and invite a reviewer +1. address the remarks of the reviewer +1. check that all tests passed +1. merge the pull request, choosing the `squash` option + +It is OK to merge your own pull request without review if you are very sure it will not cause any problems. If in doubt, ask on Telegram. + +#### Commit messages +1. shall start with capital letter +1. imperative form + +**Examples** +- Fix division-by-zero error +- Improve docstrings +- Implement feature #23 +- Add function cool_feature() \ No newline at end of file From 03a816f25af4d36e1148064577e31a9bd56ce579 Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Fri, 14 Mar 2025 07:41:40 +0100 Subject: [PATCH 3/5] Add section Coding style --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8238483..42a6a515 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,4 +31,11 @@ It is OK to merge your own pull request without review if you are very sure it w - Fix division-by-zero error - Improve docstrings - Implement feature #23 -- Add function cool_feature() \ No newline at end of file +- Add function cool_feature() + +#### Coding style +1. variable and function names lower case, use underscore if needed +1. Types and structs CamelCase +1. indent with four spaces +1. max 120 char per line +1. do NOT use an automated code formatter \ No newline at end of file From f17203064bf6d2b50ebc51a4048e17f5bf8ca369 Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Fri, 14 Mar 2025 07:54:05 +0100 Subject: [PATCH 4/5] Add section File formats --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42a6a515..4b12e96d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,4 +38,15 @@ It is OK to merge your own pull request without review if you are very sure it w 1. Types and structs CamelCase 1. indent with four spaces 1. max 120 char per line -1. do NOT use an automated code formatter \ No newline at end of file +1. do NOT use an automated code formatter + +#### File formats +1. input files: preferably `.yaml`format +1. CAD geometries: `.obj` files +1. multi-dimensional arrays: `.mat` files +1. CSV files can be used for polars for example, but if the polars are part of wing description better have one `.yaml` file that describes all aspects of the wing + +**Open questions** +- what are `.dat` files? +- shall we use `.bin` files? +- shall we use `.JLD2` files? \ No newline at end of file From 38f9c1a9ea73aba28c41d6ab203af26981fdcbd5 Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Fri, 14 Mar 2025 07:58:03 +0100 Subject: [PATCH 5/5] Mention `pushing to main` --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b12e96d..6871a3a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,8 @@ It is OK to merge your own pull request without review if you are very sure it will not cause any problems. If in doubt, ask on Telegram. +It is OK to push directly to the `main` branch for small changes for example fixing a typo in the documentation. + #### Commit messages 1. shall start with capital letter 1. imperative form