From 8299e62e8da6836a8e7a76e8b9d173f92548de59 Mon Sep 17 00:00:00 2001 From: simonsan <14062932+simonsan@users.noreply.github.com> Date: Wed, 18 Sep 2024 20:17:43 +0200 Subject: [PATCH 1/3] docs: add decision log Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com> --- src/SUMMARY.md | 1 + src/development/decision_log.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 src/development/decision_log.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index e017f8a..3c257ee 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -27,6 +27,7 @@ - [Requirements](./design/analysis/requirements.md) - [Development](./development/intro.md) - [Glossary](./development/glossary.md) + - [Decision Log](./development/decision_log.md) - [Release process](./development/release_process.md) - [Testing](./development/testing.md) - [Talks](./talks.md) diff --git a/src/development/decision_log.md b/src/development/decision_log.md new file mode 100644 index 0000000..34c0233 --- /dev/null +++ b/src/development/decision_log.md @@ -0,0 +1,13 @@ +# Decision Log + +This document contains a log of decisions made during the development within the rustic ecosystem. + +## 2024-09-16: Naming Conventions for Types + +singular = exactly only one value +plural = array, contains one value or more + +We will use the following naming conventions for the following types: + +- Singular: `Type`, exactly one value, e.g. `path: Path` +- Plural: `Vec`, an array that may contain one or more values, e.g. `paths: Vec` From 5da68694eab42bafb7d699b336d5ad6e9080b563 Mon Sep 17 00:00:00 2001 From: simonsan <14062932+simonsan@users.noreply.github.com> Date: Wed, 18 Sep 2024 20:19:41 +0200 Subject: [PATCH 2/3] remove c&p Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com> --- src/development/decision_log.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/development/decision_log.md b/src/development/decision_log.md index 34c0233..4ca70bb 100644 --- a/src/development/decision_log.md +++ b/src/development/decision_log.md @@ -4,9 +4,6 @@ This document contains a log of decisions made during the development within the ## 2024-09-16: Naming Conventions for Types -singular = exactly only one value -plural = array, contains one value or more - We will use the following naming conventions for the following types: - Singular: `Type`, exactly one value, e.g. `path: Path` From 57540541e71ea65dfc598f67fb60f572516f0c7f Mon Sep 17 00:00:00 2001 From: simonsan <14062932+simonsan@users.noreply.github.com> Date: Wed, 18 Sep 2024 20:21:29 +0200 Subject: [PATCH 3/3] fmt: dprint Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com> --- src/development/decision_log.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/development/decision_log.md b/src/development/decision_log.md index 4ca70bb..d139c4c 100644 --- a/src/development/decision_log.md +++ b/src/development/decision_log.md @@ -1,10 +1,12 @@ # Decision Log -This document contains a log of decisions made during the development within the rustic ecosystem. +This document contains a log of decisions made during the development within the +rustic ecosystem. ## 2024-09-16: Naming Conventions for Types We will use the following naming conventions for the following types: - Singular: `Type`, exactly one value, e.g. `path: Path` -- Plural: `Vec`, an array that may contain one or more values, e.g. `paths: Vec` +- Plural: `Vec`, an array that may contain one or more values, e.g. + `paths: Vec`