Split off development information

Have the README point to DEVELOPING for everything tech. NDISC-78
digitalservicebund · Dec 20, 2023 · 41c55c5 · 41c55c5
1 parent 162a310
commit 41c55c5
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 54 deletions.
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -0,0 +1,45 @@
+# Development / Tech Notes
+
+Here's what to know from a tech perspective.
+
+# The Modules
+
+Information on the modules can be found in their respective folder's README files:
+* [`./time-machine/README.md`](./time-machine/README.md)
+* [`./vscode-extension/README.md`](./vscode-extension/README.md)
+
+# The Main Repository
+
+## Architecture Decision Records
+
+[Architecture decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
+are kept in the `docs/adr` directory.
+
+For adding new records install the 
+* [`adr-tools`](https://github.com/npryce/adr-tools) package (e.g. via [`brew`](https://formulae.brew.sh/formula/adr-tools))
+
+
+See https://github.com/npryce/adr-tools for information on how to use `adr-tools` usage.
+
+
+## Git Hooks
+
+The repository contains Git hooks which support
+
+* committing only properly formatted source code, not breaking the build
+* writing commit messages that follow some convention (wrt. the merits of having a convention , cf. this [article](https://chris.beams.io/posts/git-commit/))
+* preventing accidentally pushing secrets and sensitive information
+
+### Git Hooks Setup
+In order to make use of the repository's Git hooks, 
+* [`Lefthook`](https://github.com/evilmartians/lefthook) 
+
+needs to be installed, which, in turn, makes use of the following CLI tools: 
+* [`talisman`](https://thoughtworks.github.io/talisman/docs) - scans for secrets 
+* [`gh`](https://github.com/cli/cli) - check CI status (optional)
+
+Once these tools are available, install the hooks via
+
+```bash
+lefthook install
+```
diff --git a/README.md b/README.md
@@ -13,77 +13,31 @@ The name "RIS Norms" refers to
 * "Norms", which makes explicit that within RIS, we're explicitly dealing with federal laws and similar documents (and not, for example, with court verdicts)
 
 # Structure of the Repository
-This is a mono-repository containing several independent software products. Each of these lives in its own subfolder. Right now, we have
+This is a mono-repository containing several software products. Right now, there's two of them:
 * `./time-machine`: A command line tool for applying LDML_de change commands to existing laws
 * `./vscode-extension`: A VSCode extension supporting workflows on LDML_de change commands
 
+# Development
+
+Please refer to [`DEVELOPING.md`](./DEVELOPING.md) for details.
+
 # Contributing
 
 🇬🇧
 Everyone is welcome to contribute the development of the _RIS norms documentation_. You can contribute by opening pull requests, providing documentation or answering questions or giving feedback. Please always follow the guidelines and our
 [Code of Conduct](CODE_OF_CONDUCT.md).
 
 🇩🇪
-Jede:r ist herzlich eingeladen, die Entwicklung der _RIS norms documentation_ mitzugestalten. Du kannst einen Beitrag leisten,
-indem du Pull-Requests eröffnest, die Dokumentation erweiterst, Fragen beantwortest oder Feedback gibst.
-Bitte befolge immer die Richtlinien und unseren [Verhaltenskodex](CODE_OF_CONDUCT_DE.md).
+Jede:r ist herzlich eingeladen, die Entwicklung der _RIS norms documentation_ mitzugestalten. Du kannst einen Beitrag leisten, indem du Pull-Requests eröffnest, die Dokumentation erweiterst, Fragen beantwortest oder Feedback gibst. Bitte befolge immer die Richtlinien und unseren [Verhaltenskodex](CODE_OF_CONDUCT_DE.md).
 
 ## Contributing code
 
 🇬🇧
-Open a pull request with your changes and it will be reviewed by someone from the team. When you submit a pull request,
-you declare that you have the right to license your contribution to the DigitalService and the community.
-By submitting the patch, you agree that your contributions are licensed under the MIT license.
+Open a pull request with your changes and it will be reviewed by someone from the team. When you submit a pull request, you declare that you have the right to license your contribution to the DigitalService and the community. By submitting the patch, you agree that your contributions are licensed under the MIT license.
 
 Please make sure that your changes have been tested befor submitting a pull request.
 
 🇩🇪
-Nach dem Erstellen eines Pull Requests wird dieser von einer Person aus dem Team überprüft. Wenn du einen Pull Request
-einreichst, erklärst du dich damit einverstanden, deinen Beitrag an den DigitalService und die Community zu
-lizenzieren. Durch das Einreichen des Patches erklärst du dich damit einverstanden, dass deine Beiträge unter der
-MIT-Lizenz lizenziert sind.
+Nach dem Erstellen eines Pull Requests wird dieser von einer Person aus dem Team überprüft. Wenn du einen Pull Request einreichst, erklärst du dich damit einverstanden, deinen Beitrag an den DigitalService und die Community zu lizenzieren. Durch das Einreichen des Patches erklärst du dich damit einverstanden, dass deine Beiträge unter der MIT-Lizenz lizenziert sind.
 
 Bitte stelle sicher, dass deine Änderungen getestet wurden, bevor du einen Pull Request sendest.
-
-# Development / Tech Notes
-
-## The Modules
-
-Information on the modules can be found in their respective folder's README files:
-* [`./time-machine/README.md`](./time-machine/README.md)
-* [`./vscode-extension/README.md`](./vscode-extension/README.md)
-
-## The Main Repository
-
-### Git hooks
-
-The repository contains Git hooks which support
-
-* committing only properly formatted source code, not breaking the build
-* writing commit messages that follow some convention (wrt. the merits of having a convention , cf. this [article](https://chris.beams.io/posts/git-commit/))
-* preventing accidentally pushing secrets and sensitive information
-
-#### Setup
-In order to make use of the repository's Git hooks, 
-* [`Lefthook`](https://github.com/evilmartians/lefthook) 
-
-needs to be installed, which, in turn, makes use of the following CLI tools: 
-* [`talisman`](https://thoughtworks.github.io/talisman/docs) - scans for secrets 
-* [`gh`](https://github.com/cli/cli) - check CI status (optional)
-
-Once these tools are available, install the hooks via
-
-```bash
-lefthook install
-```
-
-### Architecture Decision Records
-
-[Architecture decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
-are kept in the `docs/adr` directory.
-
-For adding new records install the 
-* [`adr-tools`](https://github.com/npryce/adr-tools) package (e.g. via [`brew`](https://formulae.brew.sh/formula/adr-tools))
-
-
-See https://github.com/npryce/adr-tools for information on how to use `adr-tools` usage.