Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create COMPATIBILITY.md #2051

Merged
merged 2 commits into from Jun 24, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions COMPATIBILITY.md
@@ -0,0 +1,27 @@
# Compatibility

This file is the canonical resource for compatibility goals for the libraries that make up Sinon.JS.

## ES5.1

The source is written as [ES5.1][ES5] and requires no transpiler or polyfills.

Sinon.JS uses feature detection to support [ES6][ES6] features, but does not rely on any of the new syntax introduced in [ES6][ES6] and remains compatible with [ES5.1][ES5] runtimes.

## Runtimes

Sinon.JS aims at supporting the following runtimes:

* Firefox 45+
* Chrome 48+
* Internet Explorer 11+
* Edge 14+
* Safari 9+
* Node LTS versions

<p align=center>
<a href="https://saucelabs.com/u/sinonjs"><img src="https://saucelabs.com/browser-matrix/sinonjs.svg" alt="Sauce Test Status"></a>
</p>

[ES5]: http://www.ecma-international.org/ecma-262/5.1/
[ES6]: http://www.ecma-international.org/ecma-262/6.0/
20 changes: 1 addition & 19 deletions CONTRIBUTING.md
Expand Up @@ -65,23 +65,7 @@ This will also install a pre-commit hook, that runs style validation on staged f

### Compatibility

#### ES5.1

Sinon's source is written as [ES5.1][ES5] and requires no transpiler or polyfills.

Sinon.JS uses feature detection to support [ES6][ES6] features, but does not rely on any of the new syntax introduced in [ES6][ES6] and remains compatible with [ES5.1][ES5] runtimes.

#### Runtimes

Sinon.JS aims at supporting the following runtimes:

* Firefox 45+
* Chrome 48+
* Internet Explorer 11+
* Edge 14+
* Safari 9+
* Node LTS versions

Please see [`COMPATIBILITY.md`][COMPATIBILITY.md]

### Linting and style

Expand Down Expand Up @@ -137,5 +121,3 @@ To build simply run
$ node build.js


[ES5]: http://www.ecma-international.org/ecma-262/5.1/
[ES6]: http://www.ecma-international.org/ecma-262/6.0/
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -26,6 +26,10 @@
<a href="https://saucelabs.com/u/sinonjs"><img src="https://saucelabs.com/browser-matrix/sinonjs.svg" alt="Sauce Test Status"></a>
</p>

## Compatibility

For details on compatibility, please see [`COMPATIBILITY.md`][COMPATIBILITY.md]
mroderick marked this conversation as resolved.
Show resolved Hide resolved

## Installation

via [npm](https://github.com/npm/npm)
Expand Down