Repositories

Modified README.md

@@ -23,7 +23,7 @@ the following command:
go get github.com/google/git-appraise/git-appraise
Then, either make sure that ${GOPATH}/bin is in your PATH, or explicitly add the
Then, either make sure that `${GOPATH}/bin` is in your PATH, or explicitly add the
"appraise" git alias by running the following command.
git config --global alias.appraise '!'"${GOPATH}/bin/git-appraise"
@@ -96,51 +96,51 @@ formats.
Code review requests are stored in the "refs/notes/devtools/reviews" ref, and
annotate the first revision in a review. They must conform to the following
schema.
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"reviewRef": {
"id": "reviewRef",
"type": "string"
},
"targetRef": {
"id": "targetRef",
"type": "string"
},
"requester": {
"type": "string"
},
"reviewers": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
},
"baseCommit": {
"type": "string"
}
},
"required": [
"targetRef"
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"reviewRef": {
"id": "reviewRef",
"type": "string"
},
"targetRef": {
"id": "targetRef",
"type": "string"
},
"requester": {
"type": "string"
},
"reviewers": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
},
"baseCommit": {
"type": "string"
}
},
"required": [
"targetRef"
]
}
```
The "reviewRef" field is used to specify a git ref that tracks the current
revision under review, and the "targetRef" field is used to specify the git ref
that should be updated once the review is approved.
@@ -150,39 +150,39 @@ that should be updated once the review is approved.
Continuous integration build and test results are stored in the
"refs/notes/devtools/ci" ref, and annotate the revision that was built and
tested. They must conform to the following schema.
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
null,
"success",
"failure"
]
},
"agent": {
"type": "string"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
}
},
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
null,
"success",
"failure"
]
},
"agent": {
"type": "string"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
}
},
}
```
The "status" field is for the final status of a build or test. The "agent"
field is a free-form string that identifies the build and test runner.
@@ -191,28 +191,28 @@ field is a free-form string that identifies the build and test runner.
Robot comments are comments generated by static analysis tools. These are
stored in the "refs/notes/devtools/analyses" ref, and annotate the revision.
They must conform to the following schema.
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"url": {
"type": "string"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
}
},
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"url": {
"type": "string"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
}
},
}
```
The "url" field should point to a publicly readable file, which contains JSON
formatted analysis results. Those results should conform to the JSON format of
the ShipshapeResponse protocol buffer message defined
@@ -224,56 +224,56 @@ Review comments are comments that were written by a person rather than by a
machine. These are stored in the "refs/notes/devtools/discuss" ref, and
annotate the first revision in the review. They must conform to the following
schema.
{
"$schema": "http://json-schema.org/draft-04/schema#",
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"author": {
"type": "string"
},
"parent": {
"type": "string"
},
"location": {
"type": "object",
"properties": {
"timestamp": {
"commit": {
"type": "string"
},
"author": {
"path": {
"type": "string"
},
"parent": {
"type": "string"
},
"location": {
"range": {
"type": "object",
"properties": {
"commit": {
"type": "string"
},
"path": {
"type": "string"
},
"range": {
"type": "object",
"properties": {
"startLine": {
"type": "integer"
}
}
"startLine": {
"type": "integer"
}
}
},
"description": {
"type": "string"
},
"resolved": {
"type": "boolean"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
}
}
},
"description": {
"type": "string"
},
"resolved": {
"type": "boolean"
},
"v": {
"type": "integer",
"default": 0,
"enum": [
null,
0
]
}
}
}
```
When the parent is specified, it must be the SHA1 hash of another comment on
the same revision, and it means this comment is a reply to that comment.
@@ -281,3 +281,7 @@ The timestamp field represents the number of seconds since the Unix epoch, and
is formatted as a 10 digit decimal number with zero padding. It should be the
first field written, so that the lexicographical ordering of comments matches
their chronological ordering.
## Contributing
Please see [the CONTRIBUTING file](CONTRIBUTING.md) for information on contributing to Git Appraise.