Skip to content

Commit

Permalink
A couple of corrections (DevExpress#895)
Browse files Browse the repository at this point in the history
  • Loading branch information
VasilyStrelyaev authored and inikulin committed Oct 19, 2016
1 parent c065259 commit 4c640ab
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
21 changes: 10 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Contributing to TestCafe

Everyone is welcome to contribute to our project and we truly appreciate your help.
TestCafe would not be possible without active support from the community.
TestCafe would not be possible without active support from the community. We certainly appreciate and would
encourage your contributions, no matter how large or small.

These guidelines help you contribute easily and painlessly.
To that end, please review our contribution guidelines first.

* [Code of Conduct](#code-of-conduct)
* [General Discussion](#general-discussion)
Expand All @@ -12,8 +12,7 @@ These guidelines help you contribute easily and painlessly.

## Code of Conduct

TestCafe has adopted a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in the project you agree to abide by its terms.
TestCafe has adopted a [Contributor Code of Conduct](CODE_OF_CONDUCT.md), abide by its terms.

## General Discussion

Expand All @@ -22,11 +21,11 @@ please visit our [discussion board](https://testcafe-discuss.devexpress.com/).

## Reporting a Problem

If anything goes wrong with TestCafe, file an issue in our [GitHub repository](https://github.com/DevExpress/testcafe/issues).
But first please search through the existing issues to see if the problem has already been reported or addressed.
If you find a problem when using TestCafe, please file an issue in our [GitHub repository](https://github.com/DevExpress/testcafe/issues).
However, to save some time, please search through the existing issues to see if the problem has already been reported or addressed.

When you create a new issue, template text is automatically added to its body. To help us understand your
problem, be sure to fill in all sections in this template.
When you create a new issue, template text is automatically added to its body.
To help us understand the issue you're describing, be sure to fill in all sections in this template.

## Code Contribution

Expand All @@ -37,7 +36,7 @@ Please follow the steps below when submitting your code.

2. If you are going to address an existing issue, check the comment thread to make sure that nobody is working on it at the moment.

3. Leave a comment saying that you are willing to fix this issue and if possible provide details on how you are going to do this.
3. Leave a comment saying that you are willing to fix this issue, and if possible, provide details on how you are going to do this.

4. Core team members may need to discuss the details of the proposed fix with you. As soon as you get the green light from them,
leave a comment saying that you are currently working on this issue.
Expand All @@ -50,7 +49,7 @@ Please follow the steps below when submitting your code.

7. Add regression tests to the appropriate sections if you are fixing a bug. You can find these sections by searching for `Regression` in the code.

Add unit and/or functional tests if you are developing new functionality.
Add unit and/or functional tests if you are developing a new functionality.

8. Fetch upstream changes and rebase your branch onto `master`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ permalink: /documentation/using-testcafe/common-concepts/browser-support.html

## Officially Supported Browsers

While TestCafe is designed to support most of the modern browsers *de facto*, there is a limited number of *officially supported* browsers for which TestCafe is being tested.
While TestCafe is designed to support most modern browsers, there are a limited number
of *officially supported* browsers against which TestCafe is actively tested.

* Google Chrome
* Internet Explorer (9+)
Expand All @@ -29,7 +30,7 @@ While TestCafe is designed to support most of the modern browsers *de facto*, th
## Locally Installed Browsers

TestCafe can automatically detect popular browsers installed on the local computer.
You can use a short name, *browser alias*, to identify these browsers when launching tests.
You can use a short name - *browser alias* - to identify these browsers when launching tests.

The following table lists browsers that can be detected automatically.

Expand All @@ -43,7 +44,8 @@ Mozilla Firefox | `firefox`
Opera | `opera`
Safari | `safari`

The list of all the available browsers can be obtained by calling the [--list-browsers](../command-line-interface.md#-b---list-browsers) command.
The list of all the available browsers can be obtained by calling the `testcafe` command
with the [--list-browsers](../command-line-interface.md#-b---list-browsers) flag.

To run tests in a different local browser, specify the path to the browser executable file.

Expand All @@ -68,7 +70,8 @@ First, you will need to create a remote browser connection.
* Command line: specify the `remote` *alias* (see [Remote Browsers](../command-line-interface.html#remote-browsers))
* API: use the [createBrowserConnection](../programming-interface/testcafe.html#createbrowserconnection) method

After that, TestCafe will provide a URL to open on the remote device in the browser against which you want to test. As you open this URL, the browser connects to the TestCafe server and starts testing.
After that, TestCafe will provide a URL to open on the remote device in the browser against which you want to test.
As you open this URL, the browser connects to the TestCafe server and starts testing.

## Browsers in Cloud Testing Services

Expand All @@ -80,14 +83,14 @@ Service | Plugin
------------------------------------ | -------------------
[Sauce Labs](https://saucelabs.com/) | [testcafe-browser-provider-saucelabs](https://www.npmjs.com/package/testcafe-browser-provider-saucelabs)

You can search npm for plugins developed by the community. Their names start with the `testcafe-browser-provider-` prefix: [https://www.npmjs.com/search?q=testcafe-browser-provider](https://www.npmjs.com/search?q=testcafe-browser-provider).
You can search npm for plugins developed by the community. Their names begin with the `testcafe-browser-provider-` prefix: [https://www.npmjs.com/search?q=testcafe-browser-provider](https://www.npmjs.com/search?q=testcafe-browser-provider).

You can also create your own plugin. See [Browser Provider Plugin](../../extending-testcafe/browser-provider-plugin/) for instructions.

## Nonconventional Browsers

To use a web browser of a different type, you will need a [browser provider plugin](../../extending-testcafe/browser-provider-plugin/).

You can search npm for plugins developed by the community. Their names start with the `testcafe-browser-provider-` prefix: [https://www.npmjs.com/search?q=testcafe-browser-provider](https://www.npmjs.com/search?q=testcafe-browser-provider).
You can search npm for plugins developed by the community. Their names begin with the `testcafe-browser-provider-` prefix: [https://www.npmjs.com/search?q=testcafe-browser-provider](https://www.npmjs.com/search?q=testcafe-browser-provider).

You can also create your own plugin. See [Browser Provider Plugin](../../extending-testcafe/browser-provider-plugin/) for instructions.

0 comments on commit 4c640ab

Please sign in to comment.