aboutsummaryrefslogtreecommitdiffstats
path: root/entity/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'entity/doc.go')
-rw-r--r--entity/doc.go8
1 files changed, 8 insertions, 0 deletions
diff --git a/entity/doc.go b/entity/doc.go
new file mode 100644
index 00000000..4682d545
--- /dev/null
+++ b/entity/doc.go
@@ -0,0 +1,8 @@
+// Package entity contains the base common code to define an entity stored
+// in a chain of git objects, supporting actions like Push, Pull and Merge.
+package entity
+
+// TODO: Bug and Identity are very similar, right ? I expect that this package
+// will eventually hold the common code to define an entity and the related
+// helpers, errors and so on. When this work is done, it will become easier
+// to add new entities, for example to support pull requests.