Repository: cordova-coho Updated Branches: refs/heads/master 73c5cdc06 -> a8a81ccef
Fix up broken markdown (at least broken according to GitHub). Project: http://git-wip-us.apache.org/repos/asf/cordova-coho/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-coho/commit/a8a81cce Tree: http://git-wip-us.apache.org/repos/asf/cordova-coho/tree/a8a81cce Diff: http://git-wip-us.apache.org/repos/asf/cordova-coho/diff/a8a81cce Branch: refs/heads/master Commit: a8a81ccef67bce4cf505c64d493b9b8c8a5e8798 Parents: 73c5cdc Author: Andrew Grieve <[email protected]> Authored: Wed Mar 12 23:12:26 2014 -0400 Committer: Andrew Grieve <[email protected]> Committed: Wed Mar 12 23:12:26 2014 -0400 ---------------------------------------------------------------------- docs/cadence-release-process.md | 9 +++++---- docs/code-reviews.md | 6 +++--- docs/committer-workflow.md | 11 ++++------- docs/plugins-release-process.md | 4 ++-- docs/processing-pull-requests.md | 12 +++++------- docs/tools-release-process.md | 3 +-- docs/versioning-and-release-strategy.md | 2 +- 7 files changed, 21 insertions(+), 26 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/cadence-release-process.md ---------------------------------------------------------------------- diff --git a/docs/cadence-release-process.md b/docs/cadence-release-process.md index 29b4ead..df938d5 100644 --- a/docs/cadence-release-process.md +++ b/docs/cadence-release-process.md @@ -152,9 +152,9 @@ To submit a fix: ### Documentation To Update For each repository: - 1. Update RELEASENOTES.md (if the file is missing, use the iOS one as a reference: [[https://github.com/apache/cordova-ios/blob/master/RELEASENOTES.md | RELEASENOTES.md]]) - * Grab changes from the previous release until now. + 1. Update RELEASENOTES.md (if the file is missing, use the iOS one as a reference: [RELEASENOTES.md](https://github.com/apache/cordova-ios/blob/master/RELEASENOTES.md)) +Grab changes from the previous release until now. # Changes: git log --pretty=format:'* %s' --topo-order --no-merges origin/3.2.x..origin/3.3.x @@ -163,7 +163,8 @@ For each repository: # Author Count: git log --pretty=format:'%an' --topo-order --no-merges origin/3.2.x..origin/3.3.x | sort | uniq | wc -l - * Edit the commit descriptions - don't add the commits verbatim, usually they are meaningless to the user. Only show the ones relevant for the user (fixes, new features) +Edit the commit descriptions - don't add the commits verbatim, usually they are meaningless to the user. Only show the ones relevant for the user (fixes, new features) + 2. Update README.md (if necessary) 3. Ensure the [Upgrade Guide](http://docs.phonegap.com/en/edge/guide_upgrading_index.md.html) for your platform is up-to-date 4. Ensure the other guides listed in the sidebar are up-to-date for your platform @@ -218,7 +219,7 @@ Refer to [tools-release-process.md](tools-release-process.md) ### Announce It! 1. Announce the release to the world! - * Create a blog post for it (instructions on [sites page README](https://svn.apache.org/repos/asf/cordova/site/README.md) + * Create a blog post for it (instructions on [sites page README](https://svn.apache.org/repos/asf/cordova/site/README.md)) * Tweet it on https://twitter.com/apachecordova * Announce to [G+ Page](https://plus.google.com/u/0/113178331525415522084/posts) http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/code-reviews.md ---------------------------------------------------------------------- diff --git a/docs/code-reviews.md b/docs/code-reviews.md index 0d1500e..a64daa2 100644 --- a/docs/code-reviews.md +++ b/docs/code-reviews.md @@ -2,11 +2,11 @@ TODO: Review Board didn't really work out :(. Come up with something better. - * Use [[http://reviews.apache.org/|reviews.apache.org]] to create a review request. + * Use http://reviews.apache.org/ to create a review request. * You will need a Review Board userid and password. One can be requested from the site. * By default, the ML will be notified of your review request. * If you have someone in particular that you would like approval from, be sure to add them in "People" field of the review. - * To create your review request is to use [[http://www.reviewboard.org/docs/rbtools/dev/|post-review]] (RBTools) from the repo with the change, only if the repo contains the file '.reviewboardrc' + * To create your review request is to use [post-review](http://www.reviewboard.org/docs/rbtools/dev/) (RBTools) from the repo with the change, only if the repo contains the file '.reviewboardrc' Currently the following repos contain .reviewboardrc: cordova-coho cordova-cli @@ -19,4 +19,4 @@ TODO: Review Board didn't really work out :(. Come up with something better. * On your workstation do a git diff and pipe the output to a file. In the new request, select the git repo, the base dir where you did the diff, upload the diff file you created, and click Create. * On the next web page, fill in the description text, the name of the Branch (i.e., "master"), the Bug (i.e., "CB-4960"), the Description and the Testing Done fields. If you want a review from a specific person, enter their userid / name in the People field. If you want input from the whole community, enter "cordova" in the Groups field. Click the Submit button. * After you have received sufficient feedback, click the button to mark your review as Discarded or Submitted [to a stream]. - * If you don't want to use !ReviewBoard you can use Github Pull Request + * If you don't want to use ReviewBoard you can use Github Pull Request http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/committer-workflow.md ---------------------------------------------------------------------- diff --git a/docs/committer-workflow.md b/docs/committer-workflow.md index 3c9525b..dc23b51 100644 --- a/docs/committer-workflow.md +++ b/docs/committer-workflow.md @@ -78,8 +78,8 @@ When possible, try to phrase things in the form of a proposal. If no one objects * When possible, rebase & squash your commits * Make sure you can figure out what your commit does by the first line of your commit discription. * If it fixes a regression, then also cherry-pick it into the appropriate release branch. - * Here is an example workflow for committing a change when you've made it on a topic branch +Here is an example workflow for committing a change when you've made it on a topic branch git pull git checkout topic_branch @@ -89,20 +89,17 @@ When possible, try to phrase things in the form of a proposal. If no one objects git push git branch -d topic_branch - * Here is an example workflow for committing a change when you've made it on master: - +Here is an example workflow for committing a change when you've made it on master: git pull --rebase git rebase origin/master -i # Squash & reword commit messages git push - * If you ever end up with a merge commit on master that you don't want: - +If you ever end up with a merge commit on master that you don't want: git rebase origin/master - * If you need to add your change to a release branch: - +If you need to add your change to a release branch: git checkout 2.9.x git cherry-pick -x COMMIT_HASH # the -x flag adds "cherry-picked from <commit>" to the commit messages http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/plugins-release-process.md ---------------------------------------------------------------------- diff --git a/docs/plugins-release-process.md b/docs/plugins-release-process.md index 126f28c..0c01500 100644 --- a/docs/plugins-release-process.md +++ b/docs/plugins-release-process.md @@ -154,8 +154,6 @@ __Body:__ ## Email the result of the vote Respond to the vote thread with: - * Note: list of PMC members: http://people.apache.org/committers-by-project.html#cordova-pmc - The vote has now closed. The results are: @@ -169,6 +167,8 @@ Respond to the vote thread with: The vote has passed. +_Note: list of PMC members: http://people.apache.org/committers-by-project.html#cordova-pmc_ + ## If the Vote does *not* Pass * Revert adding of `-dev` on dev branch * Address the concerns (on dev branch) http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/processing-pull-requests.md ---------------------------------------------------------------------- diff --git a/docs/processing-pull-requests.md b/docs/processing-pull-requests.md index 459ce82..7a0209d 100644 --- a/docs/processing-pull-requests.md +++ b/docs/processing-pull-requests.md @@ -4,19 +4,17 @@ * Ensure you are familiar with [committer-workflow.md](committer-workflow.md) ## Step 0: - * Find what requests need attention by looking a the GitHub page. - * To look at them in aggregate: + Find what requests need attention by looking a the GitHub page. +To look at them in aggregate: ./cordova-coho/coho list-pulls | tee pulls.list | less -R - * To filter out those that you last commented on: - +To filter out those that you last commented on: ./cordova-coho/coho list-pulls --hide-user=agrieve - * To show only certain repos: - +To show only certain repos: ./cordova-coho/coho list-pulls -r js -r android -r plugin-inappbrowser @@ -33,7 +31,7 @@ * If it is not there, respond with: _Thanks for the pull request. I've had a look at it and think it looks good. Before we can merge it though, you need to sign Apache's Contributor License Agreement (can be done online): http://www.apache.org/licenses/#clas_ - + ## Step 3: Merge the change Run the following as an exemplary way to merge to master: http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/tools-release-process.md ---------------------------------------------------------------------- diff --git a/docs/tools-release-process.md b/docs/tools-release-process.md index 8e720ee..ff2b6f4 100644 --- a/docs/tools-release-process.md +++ b/docs/tools-release-process.md @@ -179,8 +179,6 @@ __Body:__ ## Email the result of the vote Respond to the vote thread with: - * Note: list of PMC members: http://people.apache.org/committers-by-project.html#cordova-pmc - The vote has now closed. The results are: @@ -194,6 +192,7 @@ Respond to the vote thread with: The vote has passed. +_Note: list of PMC members: http://people.apache.org/committers-by-project.html#cordova-pmc_ ## If the Vote does *not* Pass * Revert adding of `-dev` http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/a8a81cce/docs/versioning-and-release-strategy.md ---------------------------------------------------------------------- diff --git a/docs/versioning-and-release-strategy.md b/docs/versioning-and-release-strategy.md index e1ce1c9..2dfc93e 100644 --- a/docs/versioning-and-release-strategy.md +++ b/docs/versioning-and-release-strategy.md @@ -40,5 +40,5 @@ CLI exists in both lists because its version has the format: `CadVer-SemVer` Related docs: * [storing-repo-versions-design.md](storing-repo-versions-design.md) * [cadence-release-process.md](cadence-release-process.md) -* [CommitterWorkflow](https://wiki.apache.org/cordova/CommitterWorkflow) +* [committer-workflow.md](committer-workflow.md)
