Describes motivation for git-candidate and shows an example workflow. Signed-off-by: Richard Ipsum <richard.ipsum@xxxxxxxxxxxxxxx> --- contrib/git-candidate/README.md | 154 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100644 contrib/git-candidate/README.md diff --git a/contrib/git-candidate/README.md b/contrib/git-candidate/README.md new file mode 100644 index 0000000..d2d4437 --- /dev/null +++ b/contrib/git-candidate/README.md @@ -0,0 +1,154 @@ +git-candidate +============= + +git-candidate provides candidate review and patch tracking, +it differs from other tools that provide this by storing _all_ +content within git. + +## Why? + +Existing tools such as Github's pull-requests and Gerrit are already +in wide use, why bother with something new? + +We are concerned that whilst git is a distributed version control +system the systems used to store comments and reviews for content +under version control are usually centralised, +git-candidate aims to solve this by storing +all patch-tracking data in git proper. + +## Example review process + +### Contributor - Submits a candidate + + (hack hack hack) + + (feature)$ git commit -m "Add archived repo" + (feature)$ git candidate create archivedrepo master + -m "Add support for archived repo" + Candidate archivedrepo created successfully. + (feature)$ git candidate submit origin archivedrepo + Candidate was submitted successfully. + +### Upstream - Reviews candidate + + (master)$ git candidate fetch origin + (master)$ git candidate status origin/archiverepo + Revision: 6239bd72d597357af901718becae91cee2a32b73 + Ref: candidates/origin/archiverepo + Status: active + Land: master + + Add archived repo support + + lib/gitano/command.lua | 28 ++++++++++++++++++++++------ + 1 file changed, 22 insertions(+), 6 deletions(-) + + (master)$ git show candidates/origin/archiverepo + commit 2db28539c8fa7b81122382bcc526c6706c9e113a + Author: Richard Ipsum <richard.ipsum@xxxxxxxxxxxxxxx> + Date: Thu Oct 8 10:43:22 2015 +0100 + + Add support for archived repository masking in `ls` + + By setting `project.archived` to something truthy, a repository + is thusly masked from `ls` output unless --all is passed in. + + Signed-off-by: Richard Ipsum <richard.ipsum@xxxxxxxxxxxxxxx> + .... + .... + + + (master)$ git candidate review origin/archiverepo --vote -1 + -m "Sorry, I'll need to see tests before I can accept this" + (master)$ git candidate submit origin archiverepo + Review added successfully + +### Contributor - Revises candidate + + (master)$ git candidate fetch origin + (master)$ git candidate status origin/archiverepo + Revision: 6239bd72d597357af901718becae91cee2a32b73 + Ref: candidates/origin/archiverepo + Status: active + Land: master + + Add archived repo support + + lib/gitano/command.lua | 28 ++++++++++++++++++++++------ + 1 file changed, 22 insertions(+), 6 deletions(-) + + -------------------------------------------------------------------------------- + 1 review + -------------------------------------------------------------------------------- + + Author: Emmet Hikory <persia@xxxxxxxxxxxx> + Date: Tue Oct 13 10:09:45 2015 +0100 + Vote: -1 + + Sorry, I'll need to see tests before I can accept this + + -------------------------------------------------------------------------------- + + (hack hack hack add tests) + + (feature_v2)$ git log --oneline -1 + Ensure the `ls` yarn checks for archived repos + + (feature_v2)$ git candidate revise origin/archiverepo + -m "Add archived repo support with tests" + Candidate archiverepo revised successfully. + + (feature_v2)$ git candidate submit origin archiverepo + Candidate was submitted successfully. + +### Upstream - Merges candidate + + (master)$ git candidate fetch origin + (master)$ git candidate status origin/archiverepo + Revision: 4cd3d1197d399005a713ca55f126a9086356a072 + Ref: candidates/origin/archiverepo + Status: active + Land: master + + Add archived repo support with tests + + lib/gitano/command.lua | 28 ++++++++++++++++++++++------ + testing/02-commands-ls.yarn | 19 +++++++++++++++++++ + 2 files changed, 41 insertions(+), 6 deletions(-) + + (master)$ git candidate review origin/archiverepo --vote +2 + -m "Looks good, merging. Thanks for your efforts" + Review added successfully + + (master)$ git candidate submit origin archiverepo + Candidate was submitted successfully. + + (master)$ git merge candidates/origin/archiverepo + (master)$ git push origin master + +### Contributor - Observes candidate has been accepted + + (feature_v2)$ git candidate fetch origin + (feature_v2)$ git candidate status origin/archiverepo + Revision: 4cd3d1197d399005a713ca55f126a9086356a072 + Ref: candidates/origin/archiverepo + Status: active + Land: master + + Add archived repo support with tests + + lib/gitano/command.lua | 28 ++++++++++++++++++++++------ + testing/02-commands-ls.yarn | 19 +++++++++++++++++++ + 2 files changed, 41 insertions(+), 6 deletions(-) + + -------------------------------------------------------------------------------- + 1 review + -------------------------------------------------------------------------------- + + Author: Emmet Hikory <persia@xxxxxxxxxxxx> + Date: Tue Oct 13 10:35:00 2015 +0100 + Vote: +2 + + Looks good, merging. Thanks for your efforts + + -------------------------------------------------------------------------------- -- 2.1.4 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html