aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChloe Kudryavtsev <toast@toastin.space>2019-03-17 14:12:16 -0400
committerChloe Kudryavtsev <toast@toastin.space>2019-03-17 14:12:16 -0400
commit737f3a244e7902735b0fdb08ebf80396b1be1c6f (patch)
treeec98a764f726e2d3e0d5655b245ebb43bb10d4cb /README.md
downloadgovernance-737f3a244e7902735b0fdb08ebf80396b1be1c6f.tar.bz2
governance-737f3a244e7902735b0fdb08ebf80396b1be1c6f.tar.xz
Initial commit
Add all the scaffolding
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d486ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Developer Handbook
+
+This is the Antora component for the Alpine Developer Handbook.
+It contains various pertinent information regarding the Alpine Linux project, its organization, and contains instructions on how to contribute and/or join.
+
+## Deploying
+
+You cannot display this "on its own" - you will need to either see the instructions in the [playbook repostory](https://git.alpinelinux.org/docs/docs.a.o/) or write your own Antora playbook.
+
+## Contributing
+
+If you want to send a patch, and your name is not yet in the authors list, please add it there.
+Do also note that by contributing the patch, assuming that you have not done so yet, you are agreeing to license your patch (and all future ones) under the license of the repository.
+You will be explicitly asked to confirm that in whatever medium you submit that patch (or you may confirm this in your patch commit message).