From c70605bf6f91f4adf98aedc3c1c029dbade54828 Mon Sep 17 00:00:00 2001 From: VGanivet <virginie@cividesk.com> Date: Sun, 5 Jun 2016 16:35:54 -0600 Subject: [PATCH] Update testing.md Proof read. --- docs/testing.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/testing.md b/docs/testing.md index 2dace814..47063345 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -1,19 +1,19 @@ Testing ======= -Testing in CiviCRM is done by a conbination of human code review and testing as well as automated testing. Testing is done based on pull requests (PRs) in [Github](https://github.com/civicrm/civicrm-core/pulls). PRs are generally a response to issues reported in [JIRA](https://issues.civicrm.org/) the issue tracking system for CiviCRM . +Testing in CiviCRM is done by a combination of human code review and testing as well as automated testing. Testing is done based on pull requests (PRs) in [Github](https://github.com/civicrm/civicrm-core/pulls). PRs are generally a response to issues reported in [JIRA](https://issues.civicrm.org/), the issue tracking system for CiviCRM. Automated tests --------------- -TODO: +TO DO: * http://wiki.civicrm.org/confluence/display/CRMDOC/Testing Manual testing --------------- -When testing we do testing this is the proccess we should use: +When testing this is the proccess you should use: -* Check at the the PR is paired with a JIRA issue +* Check if the PR is paired with a JIRA issue * Read the JIRA ticket * Look at the bug in JIRA and ask yourself if you agree with the analysis of the bug * Check if the automated tests have passed @@ -21,9 +21,9 @@ When testing we do testing this is the proccess we should use: * Comment on the Github PR if you managed to replicate the issue, and how. * Check that the bug has been fixed with the patch -In order to reproduce the bug you can reproduce the issue in the appropraite [CiviCRM Sandbox](https://civicrm.org/sandboxes). Enabling debugging can help to get more details. +In order to reproduce the bug you can reproduce the issue in the appropriate [CiviCRM Sandbox](https://civicrm.org/sandboxes). Enabling debugging can help to get more details. -CiviCRM uses a system called Jenkins to do out automated testing. To get to Jenkins results for a specific PR click *Show all checks* and then *Details*. +CiviCRM uses a system called Jenkins to do automated testing. To get to Jenkins results for a specific PR click *Show all checks* and then *Details*.  @@ -35,7 +35,7 @@ There are multiple times that CMS_URL is in the log output. If a PR is updated or re-tested, the initial test site will be deleted (since a new test site will have been created). -If the tests have failed for something that we suspect is a random failiure, we can ask Jenkins to run the tests again by commenting in the PR "Jenkins, test this please". [see] (https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin). New contributors to CiviCRM will require an admin to approve running the tests by commenting on the PR "ok to test". Jenkins will automatically respond "can an admin verify this patch?" If the user is trusted, CiviCRM administrators can add the person to the whitelist by commenting "add to whitelist". +If the tests have failed for something that we suspect is a random failure, we can ask Jenkins to run the tests again by commenting in the PR "Jenkins, test this please". [see] (https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin). New contributors to CiviCRM will require an admin to approve running the tests by commenting on the PR "ok to test". Jenkins will automatically respond "can an admin verify this patch?" If the user is trusted, CiviCRM administrators can add the person to the whitelist by commenting "add to whitelist". Jenkins only builds a Drupal site that is built against the branch that your PR is modifying. If you need to test a patch against another CMS than you will want to test the patch in your own environment. @@ -47,13 +47,13 @@ Hub example where 8473 is the PR ID. Git example where 8473 is the PR ID and 4.6 is the branch. `git fetch origin pull/8473/head:4.6` -If you do not have an existing environment you can use Buildkit to create one quickly. [Buildkit](https://github.com/civicrm/civicrm-buildkit) is a powerfull command line tool for CiviCRM that allows for rapidly creating CiviCRM environments. Buildkit can create installs for Drupal7, Drupal6, WordPress and Backdrop. +If you do not have an existing environment you can use Buildkit to create one quickly. [Buildkit](https://github.com/civicrm/civicrm-buildkit) is a powerful command line tool for CiviCRM that allows for rapidly creating CiviCRM environments. Buildkit can create installs for Drupal7, Drupal6, WordPress and Backdrop. -You can for example run `civibuild create dmaster --url http://localhost:8001 --patch https://github.com/civicrm/civicrm-core/pull/8494 --admin-pass s3cr3t` and you will get a test environment with the Drupal, CiviCRM master branch and the patch in PR 8494. You can get much more detailed information in the [Civibuild documentation](https://github.com/civicrm/civicrm-buildkit/blob/master/doc/civibuild.md) +You can for example run `civibuild create dmaster --url http://localhost:8001 --patch https://github.com/civicrm/civicrm-core/pull/8494 --admin-pass s3cr3t` and you will get a test environment with the Drupal, CiviCRM master branch and the patch in PR 8494. You can get much more detailed information in the [Civibuild documentation](https://github.com/civicrm/civicrm-buildkit/blob/master/doc/civibuild.md) -Every month, a release announcement message is sent to participants in the review process. The announcement is sent on the [civicrm-dev mailing-list](http://lists.civicrm.org/lists/info/civicrm-dev) and issue is posted on [github.com/civicrm](http://github.com/civicrm). The GitHub post has the account names of everyone who has submitted a PR recently will be mentioned (so that they get a notification). +Every month, a release announcement message is sent to participants in the review process. The announcement is sent on the [civicrm-dev mailing-list](http://lists.civicrm.org/lists/info/civicrm-dev) and issue is posted on [github.com/civicrm](http://github.com/civicrm). The GitHub post mentions the account names of everyone who has submitted a PR recently (so that they get a notification). -###Notifcations +###Notifications * When opening a PR, submitter is pointed to the CiviCRM Core [contributing documentation](https://github.com/civicrm/civicrm-core/blob/master/.github/CONTRIBUTING.md) * At start of month @mentions is used to ping authors, e.g. [https://github.com/civicrm/release-management/issues/2](https://github.com/civicrm/release-management/issues/2) * The notice to authors contains the Release Planning spreadsheet. For [example](https://docs.google.com/spreadsheets/d/10EyNqm3-CbAwUjYzckrwSE7VjpZCfatzh-bES59XqA8/edit?usp=sharing). -- GitLab