CYFS
here.Branch | Description | Inclusion conditions | Manager |
---|---|---|---|
official | Documents approved by the team | Accurate content, high level of writing, easy to understand | Senior developers of relevant modules + project administrators |
checked | Documentation reviewed by the team | The content is accurate, but the writing is flawed and difficult to read | Senior developers of relevant modules or project administrators |
draft | Unchecked document | There may be errors in the content, which need to be corrected. If you find an error, you can initiate a discussion or submit a Pull request to correct it. |
Any one can update the repository |
When you want to submit a document, you should do as follow:
draft
to your own repository.Pull request
to the branch draft
in official repository.When someone with write
permissions find a Pull request
, he can do as follow:
draft
.The managers periodically compares draft
and checked
branches, They will check the Commit
s as follow:
Patch
include the proofreaded Commit
s in the draft
branch.Commit
s with errors and feedback to the writer(create a discussion and @ the auther?).How to decide to include the Patch
?
Patch
, the lead developers of related modules and managers are invited to join.Patch
will be included in the checked
branch, otherwise the error in it will be noted.If the score is high enough, the Patch
will be included in the official
branch.
Notes: We use cherry-pick
or format-patch
to merge each commit, instead of merge
or rebase
, to avoid merging unqualified commits into. Therefore, we should submit as little and complete content as possible each time.
git cherry-pick <commit-hash>
git format-path ...