MichaelMure/git-bug
1
1
Fork 0
mirror of https://github.com/MichaelMure/git-bug.git synced 2024-12-14 17:51:44 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #239 from hoijui/model-mods

Browse Source 
Clarify model.md a bit
This commit is contained in:
Michael Muré 2019-10-29 13:14:35 +00:00 committed by GitHub
commit 11b4a1beb7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -14,6 +14,7 @@
</div>
`git-bug` is a bug tracker that:
- **fully embed in git**: you only need your git repository to have a bug tracker
- **is distributed**: use your normal git remote to collaborate, push and pull your bugs !
- **works offline**: in a plane or under the sea ? keep reading and writing bugs

34
doc/model.md
View File

@ -8,23 +8,33 @@ The biggest problem when creating a distributed bug tracker is that there is no
To deal with this problem, you need a way to merge these changes in a meaningful way.
Instead of storing directly the final bug data, we store a series of edit `Operation`s. One such operation could looks like this:
Instead of storing the final bug data directly, we store a series of edit `Operation`s.
Note: In git-bug internally it is a golang struct, but in the git repo it is stored as JSON, as seen later.
These `Operation`s are aggregated in an `OperationPack`, a simple array. An `OperationPack` represents an edit session of a bug. We store this pack in git as a git `Blob`; that consists of a string containing a JSON array of operations. One such pack -- here with two operations -- might look like this:
```json
{
"type": "SET_TITLE",
"author": {
"id": "5034cd36acf1a2dadb52b2db17f620cc050eb65c"
[
{
"type": "SET_TITLE",
"author": {
"id": "5034cd36acf1a2dadb52b2db17f620cc050eb65c"
},
"timestamp": 1533640589,
"title": "This title is better"
},
"timestamp": 1533640589,
"title": "This title is better"
}
{
"type": "ADD_COMMENT",
"author": {
"id": "5034cd36acf1a2dadb52b2db17f620cc050eb65c"
},
"timestamp": 1533640612,
"message": "A new comment"
}
]
```
Note: Json provided for readability. Internally it's a golang struct.
These `Operation`s are aggregated in an `OperationPack`, a simple array. An `OperationPack` represents an edit session of a bug. We store this pack in git as a git `Blob`; that is arbitrary serialized data.
To reference our `OperationPack`, we create a git `Tree`; it references our `OperationPack` `Blob` under `"\ops"`. If any edit operation includes a media (for instance in a message), we can store that media as a `Blob` and reference it here under `"/media"`.
To complete the picture, we create a git `Commit` that references our `Tree`. Each time we add more `Operation`s to our bug, we add a new `Commit` with the same data-structure to form a chain of `Commit`s.