Skip to content

Commit

Permalink
[docs] Update issues, questions and contributing (#3012)
Browse files Browse the repository at this point in the history
* [docs] Update issues, questions and contributing

1. Moved stackoverflow questions to the 'community' section
2. Updated links for bug reports and feature requests
3. Updated the contributing descrtiption, added a 'thank you note' for contributors. Now we can just add a list to the end of this section.
4. Moved the 'badge' section to the end.

* Removed an extra empty line

* Update README.md

Updated according to Vasily's comment

* Fixed a typo in "Issue Tracker"

* Changed http to https

Co-Authored-By: Nuarat <natalielielie@gmail.com>

* Added a comma

Co-Authored-By: Nuarat <natalielielie@gmail.com>

* Put "Issue Tracker" after the "Get Help" section
  • Loading branch information
Nuarat authored and VasilyStrelyaev committed Oct 30, 2018
1 parent cb47bbb commit 36f4b7f
Showing 1 changed file with 29 additions and 19 deletions.
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@
* [IDE for End-to-End Web Testing](#ide-for-end-to-end-web-testing)
* [Getting Started](#getting-started)
* [Documentation](#documentation)
* [Community](#community)
* [Badge](#badge)
* [Get Help](#get-help)
* [Issue Tracker](#issue-tracker)
* [Stay in Touch](#stay-in-touch)
* [Contributing](#contributing)
* [Plugins](#plugins)
* [Different versions of TestCafe](#different-versions-of-testcafe)
* [Different Versions of TestCafe](#different-versions-of-testcafe)
* [Badge](#badge)
* [License](#license)
* [Creators](#creators)

Expand Down Expand Up @@ -158,31 +160,25 @@ Read the [Getting Started](https://devexpress.github.io/testcafe/documentation/g

## Documentation

Go to our website for full [documentation](http://devexpress.github.io/testcafe/documentation/using-testcafe/) on TestCafe.
Go to our website for full [documentation](https://devexpress.github.io/testcafe/documentation/getting-started/) on TestCafe.

## Community
## Get Help

Follow us on [Twitter](https://twitter.com/DXTestCafe). We post TestCafe news and updates, several times a week.
Join the TestCafe community on Stack Overflow to get help. Ask and answer [questions with the TestCafe tag](https://stackoverflow.com/questions/tagged/testcafe).

## Badge
## Issue Tracker

Show everyone you are using TestCafe: ![Tested with TestCafe](https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg)
Use our GitHub issues page to [report bugs](https://github.com/DevExpress/testcafe/issues/new?template=bug-report.md) and [suggest improvements](https://github.com/DevExpress/testcafe/issues/new?template=feature_request.md).

To display this badge, add the following code to your repository readme:
## Stay in Touch

```html
<a href="https://github.com/DevExpress/testcafe">
<img alt="Tested with TestCafe" src="https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg">
</a>
```
Follow us on [Twitter](https://twitter.com/DXTestCafe). We post TestCafe news and updates, several times a week.

## Contributing

Report bugs and request features on our [issues page](https://github.com/DevExpress/testcafe/issues).<br/>
Ask and answer questions on StackOverflow. We review and answer [questions with the TestCafe tag](https://stackoverflow.com/questions/tagged/testcafe).<br/>
For more information on how to help us improve TestCafe, see the [CONTRIBUTING.md](https://github.com/DevExpress/testcafe/blob/master/CONTRIBUTING.md).
Read our [Contributing Guide](https://github.com/DevExpress/testcafe/blob/master/CONTRIBUTING.md) to learn how to contribute to the project.

You can use these plugin generators to create your own plugins:
To create your own plugin for TestCafe, you can use these plugin generators:

* [Build a browser provider](https://devexpress.github.io/testcafe/documentation/extending-testcafe/browser-provider-plugin/)
to set up tests on your on-premises server farm, to use a cloud testing platform, or to start your local browsers in a special way. Use this [Yeoman generator](https://www.npmjs.com/package/generator-testcafe-browser-provider) to write only a few lines of code.
Expand All @@ -191,6 +187,8 @@ You can use these plugin generators to create your own plugins:

If you want your plugin to be listed below, [send us a note in a Github issue](https://github.com/DevExpress/testcafe/issues/new).

Thank you to all the people who already contributed to TestCafe!

## Plugins

TestCafe developers and community members made these plugins:
Expand Down Expand Up @@ -241,7 +239,7 @@ TestCafe developers and community members made these plugins:
Use ESLint when writing and editing TestCafe tests.
* [ESLint plugin](https://github.com/miherlosev/eslint-plugin-testcafe) (by [@miherlosev](https://github.com/miherlosev))

## Different versions of TestCafe
## Different Versions of TestCafe

There is a line of products called `TestCafe`. Below are the similarities and key differences between them.

Expand Down Expand Up @@ -270,6 +268,18 @@ There is a line of products called `TestCafe`. Below are the similarities and ke
* New [Visual Test Recorder](https://testcafe-studio.devexpress.com/documentation/guides/record-tests/) and [IDE-like GUI](https://testcafe-studio.devexpress.com/documentation/guides/write-test-code.html) to record, edit, run and debug tests.
* Currently available as a free preview version. The release version will replace the 2013 version of TestCafe.

## Badge

Show everyone you are using TestCafe: ![Tested with TestCafe](https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg)

To display this badge, add the following code to your repository readme:

```html
<a href="https://github.com/DevExpress/testcafe">
<img alt="Tested with TestCafe" src="https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg">
</a>
```

## Thanks to BrowserStack

We are grateful to BrowserStack for providing the infrastructure that we use to test code in this repository.
Expand Down

0 comments on commit 36f4b7f

Please sign in to comment.