Add how-to-start-using-adrs-with-git

maubertin · Nov 7, 2023 · c99aab6 · c99aab6
1 parent e0554f3
commit c99aab6
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/locales/en/doc/how-to-start-using-adrs-with-git/.locale-peer-id b/locales/en/doc/how-to-start-using-adrs-with-git/.locale-peer-id
@@ -0,0 +1 @@
+d6fb3c7d91f95003163e694e74058e9d
diff --git a/locales/en/doc/how-to-start-using-adrs-with-git/README.md b/locales/en/doc/how-to-start-using-adrs-with-git/README.md
@@ -0,0 +1 @@
+index.md
diff --git a/locales/en/doc/how-to-start-using-adrs-with-git/index.md b/locales/en/doc/how-to-start-using-adrs-with-git/index.md
@@ -0,0 +1,19 @@
+# How to start using ADRs with git
+
+If you like using git version control, then here is how we like to start using ADRs with git for a typical software project with source code.
+
+Create a directory for ADR files:
+
+```sh
+$ mkdir adr
+```
+
+For each ADR, create a text file, such as `database.txt`:
+
+```sh
+$ vi database.txt
+```
+
+Write anything you want in the ADR. See the templates in this repository for ideas.
+
+Commit the ADR to your git repo.