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

[WIP] Set _urls on referenced content_type entries #58

Open
wants to merge 11 commits into
base: es2016
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ lib-cov
.lock-wscript
build/Release
.nyc_output
test/fixtures/*/public
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ language: node_js
node_js:
- "5"
after_script:
- npm run coverage
- npm run coveralls
sudo: false
8 changes: 7 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
build:
npm run build

coverage:
coverage::
npm run coverage

coveralls:
Expand All @@ -12,3 +12,9 @@ release:

lint:
npm run lint

debug-test:
npm run debug-test

test::
npm test
36 changes: 21 additions & 15 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Contributing to Roots-contentful
# Contributing to `roots-contentful`

Hello there! First of all, thanks for being interested in this project and helping out. We all think you are awesome, and by contributing to open source projects, you are making the world a better place. That being said, there are a few ways to make the process of contributing code to this project smoother, detailed below:

Expand All @@ -14,9 +14,9 @@ If you are opening an issue about a bug, make sure that you include clear steps
- Run `npm install`
- Put in work

### `pre-push`, `pre-commit` Linting
### `pre-commit` Linting

Provided dependencies are installed, `git push` and `git commit` will
Provided dependencies are installed, `git commit` will
not work unless this project passes a linting check.

### Build Commands
Expand All @@ -26,32 +26,35 @@ not work unless this project passes a linting check.

#### Testing

This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it. The test suite for this project uses [mocha](http://visionmedia.github.io/mocha/) and [chai](http://chaijs.com/)
This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it. The test suite for this project uses [AVA](https://github.com/sindresorhus/ava).

To lint the source:

```
```shell
$ make lint
```

To lint the source and run the tests:

```bash
$ npm test
# or, for optional request logging:
$ NODE_DEBUG=request npm test
```shell
$ make test
```

By default, tests will run concurrently/in parallel. When debugging, this can sometimes lead to unwanted behavior. For this reason, there is a `debug-test` command that will fail as soon as the first test fails, run tests serially, enable more verbose output and also log any HTTP requests:

```shell
$ make debug-test
```

To create a coverage report:

```
```shell
$ make coverage
```

To feed a coverage report to coveralls:

```
```shell
$ make coveralls
```

Expand All @@ -62,24 +65,27 @@ $ make coveralls
Building involves compiling the ES2016 syntax down to
regular ES5 using [Babel](http://babeljs.io). This command will run the tests - on success it will then compile the contents of `src/` into `lib/`.

```
```shell
$ make build
```

#### Publishing to NPM

This command will lint the project files, run the tests, build the project, publish the build to NPM and then perform a `git push --follow-tags`.

```
```shell
$ make release
```

A typical publish workflow might look something like this:

```
$ git checkout master
```shell
$ git checkout Fix/bug-fix
# add some code...
$ git add .
$ git commit -m "fixed a bug"
$ git checkout master
$ git merge Fix/bug-fix
$ npm version patch
$ make release
```
Expand Down
3 changes: 0 additions & 3 deletions old_test/mocha.opts

This file was deleted.

Loading