chore(npm): added package-lock (#292)
[cordova-coho.git] / docs / code-reviews.md
index a64daa2dfe4db13245c53737b62d4deb5adc3e1e..dcebf9b3fd0b267aaa88087f679fc818b572952a 100644 (file)
@@ -1,22 +1,28 @@
-# Code Reviews
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
 
-TODO: Review Board didn't really work out :(. Come up with something better.
+# Code Reviews
 
- * 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 [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
-     cordova-android
-     cordova-ios
-     cordova-js
+We use GitHub pull requests for code reviews.
+1. Commit to a branch on your own fork of the repo that you're changing
+2. Use GitHub to create a pull request
+3. Email out the link to it to dev@cordova.apache.org
 
-   * If you don't want to use post-review tool, then on the web site:
-     * Click "New Review Request"
-     * 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