From 36ab50b467fc00128888699992e0215debe645df Mon Sep 17 00:00:00 2001 From: antifallobst Date: Thu, 20 Jul 2023 00:40:21 +0200 Subject: [PATCH 1/5] Docs(Philosophy): Added a WIP design philosophy for the project. --- docs/Philosophy.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/Philosophy.md diff --git a/docs/Philosophy.md b/docs/Philosophy.md new file mode 100644 index 0000000..15d4e00 --- /dev/null +++ b/docs/Philosophy.md @@ -0,0 +1,16 @@ +# Design Philosophy + +## Customizability +Trinitrix aims to be highly customizable. +The command API provides a customizazion method, can be used by an initial config script and live by the user. +The command API should cover at least 90% of the possible configuration settings. + +## Cross Platform +Trinitrix is cross platform. +Even if the targeted user group are nerdy linux users. +This can be easily achieved by using only cross platform libraries such as `crossterm` or `tui`. + +## Future Proof / Extensible +Modules and Interfaces should be designed in a way, that they're not limited to one use case. +A good example is the command API, which is a unified way to interact with the application. +It can used via lua, but use cases like fetching commands using http are theoretically possible too. From 9c9da443418b46526565b13aa34bc9cc4e0160ba Mon Sep 17 00:00:00 2001 From: antifallobst Date: Thu, 20 Jul 2023 00:59:47 +0200 Subject: [PATCH 2/5] Docs(Philosophy): Fixed a typo --- docs/Philosophy.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/Philosophy.md b/docs/Philosophy.md index 15d4e00..0d2ea6c 100644 --- a/docs/Philosophy.md +++ b/docs/Philosophy.md @@ -2,15 +2,16 @@ ## Customizability Trinitrix aims to be highly customizable. -The command API provides a customizazion method, can be used by an initial config script and live by the user. +The command API provides a customizazion method, which can be used by an initial config script or live from the intern cli by the user. The command API should cover at least 90% of the possible configuration settings. ## Cross Platform Trinitrix is cross platform. -Even if the targeted user group are nerdy linux users. +Even if the targeted users are nerdy linux users xD. This can be easily achieved by using only cross platform libraries such as `crossterm` or `tui`. ## Future Proof / Extensible -Modules and Interfaces should be designed in a way, that they're not limited to one use case. +Modules and Interfaces should be designed in a way, that they're not limited to only use case. +They should be open for every usecase, that makes sense. A good example is the command API, which is a unified way to interact with the application. It can used via lua, but use cases like fetching commands using http are theoretically possible too. From 80f8c1709fe177aa989544bd32a2f6deb11e5b25 Mon Sep 17 00:00:00 2001 From: antifallobst Date: Thu, 20 Jul 2023 01:21:40 +0200 Subject: [PATCH 3/5] Docs: update the commit message format to a modified version of the AngularJS commit message style --- docs/CommitMessageStyle.md | 120 +++++++++++++++++++++++++++++++------ 1 file changed, 101 insertions(+), 19 deletions(-) diff --git a/docs/CommitMessageStyle.md b/docs/CommitMessageStyle.md index 37007f0..fa5d5a4 100644 --- a/docs/CommitMessageStyle.md +++ b/docs/CommitMessageStyle.md @@ -1,29 +1,111 @@ # Commit message style +*This specification is heavily inspired by the [AngularJS commit message format][https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format].* -Commit messages have to align with the following style: +We have very precise rules over how our Git commit messages must be formatted. +This format leads to **easier to read commit history**. -` (): ` +Each commit message consists of a **header**, a **body** (optional), and a **footer** (optional). -Pull requests that don't align with this style probably won't be accepted. -## type -The type of change to be committed. +``` +
+ + + +