Skip to content
This repository was archived by the owner on Oct 10, 2022. It is now read-only.

Commit dcfe15a

Browse files
committed
CHANGELOG and CONTRIBUTING updates
1 parent a083ee3 commit dcfe15a

File tree

2 files changed

+43
-11
lines changed

2 files changed

+43
-11
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# netlify Change Log
2+
All notable changes to this project will be documented in this file.
3+
This project adheres to [Semantic Versioning](http://semver.org/).
4+
5+
## 2.0.1 - 2018-09-25
6+
* A whole new Netlify Node.js API client! 🎉
7+
* Client code was extracted from our forthcoming [2.0.0 CLI](https://www.netlify.com/blog/2018/09/10/netlify-cli-2.0-now-in-beta-/) release.
8+
* A completely new API. Treat the 2.x.x and forward as a completely separate codebase and API.
9+
* API calls are now derived from the [open-api](https://github.com/netlify/open-api) specification. See the [swagger-ui](https://open-api.netlify.com/#/default) and know that there is a matching API method for every operationID (the name on the right). See the README for full API docs.
10+
* Includes a method for creating content based deploys.

CONTRIBUTING.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,51 @@ please read the [code of conduct](CODE_OF_CONDUCT.md).
55

66
## Setup
77

8-
> Install NPM on your system: https://docs.npmjs.com/getting-started/installing-node
8+
> Install Node.js + npm on your system: https://nodejs.org/en/download/
99
1010
```sh
1111
$ git clone https://github.com/netlify/js-client netlify-js-client
1212
$ cd netlify-js-client
1313
$ npm install
14+
$ npm test
1415
```
1516

17+
You can also use yarn.
18+
1619
## Testing
1720

18-
```sh
19-
$ jasmine-node spec
20-
```
21+
This repo uses [ava](https://github.com/avajs/ava) for testing.
22+
Any files in the `src` directory that have a `.test.js` file extension are automatically detected and run as tests.
23+
24+
We also test for a few other variables:
25+
26+
- Dependencies (used an unused)
27+
- Linting
28+
- Coverage
29+
- Must work with Windows + Unix environments.
2130

22-
## Pull Requests
31+
## Architecture
2332

24-
We actively welcome your pull requests.
33+
We target Node.js LTS and stable environments, and aim for basic modern browser support when possible.
34+
In order to facilitate simple contributions, we avoided any kind of build steps.
2535

26-
1. Fork the repo and create your branch from `master`.
27-
2. If you've added code that should be tested, add tests.
28-
3. If you've changed APIs, update the documentation.
29-
4. Ensure the test suite passes.
30-
5. Make sure your code lints.
36+
If you need to add new API routes, please add them to the [open-api](https://github.com/netlify/open-api) repo.
37+
This client will automatically inherent the new routes from that module.
38+
39+
Projects that depend heavily on this client that should be taken into consideration when making changes:
40+
41+
- [netlify/cli](https://github.com/netlify/cli)
42+
43+
## Releasing
44+
45+
```console
46+
# Make changes
47+
# Update the changelog
48+
$ npm version [major|minor|patch]
49+
$ git push && git push --tags
50+
# Create a github release with the changelog contents
51+
$ npm publish
52+
```
3153

3254
## License
3355

0 commit comments

Comments
 (0)