Skip to content

Commit

Permalink
Merge pull request #802 from nschonni/patch-2
Browse files Browse the repository at this point in the history
chore: Add codefences for Contributing.md
  • Loading branch information
WilcoFiers committed Mar 27, 2018
2 parents 4ba8c3f + 5c91a6f commit 03cf586
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ We expect all code to be 100% covered by tests. We don't have or want code cover

Functions should contain a preceding comment block with [jsdoc](http://usejsdoc.org/) style documentation of the function. For example:

```
```javascript
/**
* Runs the Audit; which in turn should call `run` on each rule.
* @async
Expand All @@ -55,7 +55,7 @@ Functions should contain a preceding comment block with [jsdoc](http://usejsdoc.

Classes should contain a jsdoc comment block for each attribute. For example:

```
```javascript
/**
* Constructor for the result of checks
* @param {Object} check CheckResult specification
Expand Down Expand Up @@ -95,20 +95,20 @@ In order to get going, fork and clone the repository. Then, if you do not have [

Once the basic infrastructure is installed, from the repository root, do the following:

```
```console
npm install
```

To run tests:

```
```console
grunt test
```
>Note: Firefox 47 is not compatible with Selenium Webdriver. To run tests, you can [downgrade to Firefox 46](https://ftp.mozilla.org/pub/firefox/releases/) until 47.0.1 comes out.
To build the package:

```
```console
grunt build
```

Expand All @@ -119,12 +119,14 @@ grunt build
The TypeScript definition file for axe-core is distributed with this module and can be found in [axe.d.ts](./axe.d.ts). It currently supports TypeScript 2.0+.

To maintain aXe support for TypeScript you must first install it (globally recommended):
```

```console
sudo npm -g install typescript
```

Once that's installed, you can run TypeScript definition tests (with the optional `--noImplicitAny` flag):
```

```console
tsc --noImplicitAny typings/axe-core/axe-core-tests.ts
```

Expand Down Expand Up @@ -155,13 +157,13 @@ Start the build using the "Retry the build with SSH enabled" option in the Circl

Copy the SSH command and add the -X flag to it for example

```
```console
ssh -X -p 64605 ubuntu@13.58.157.61
```

When you login, set up the environment and start the chrome browser

```
```console
export DISPLAY=localhost:10.0
/opt/google/chrome/chrome
```
Expand All @@ -170,7 +172,7 @@ export DISPLAY=localhost:10.0

Edit the ~/.Xauthority file and just save it with the following commands

```
```console
vi ~/.Xauthority
:wq
```
Expand All @@ -179,7 +181,7 @@ vi ~/.Xauthority

Log into a second ssh terminal (without -X) and execute the following commands

```
```console
cd axe-core
grunt connect watch
```
Expand Down

0 comments on commit 03cf586

Please sign in to comment.