Skip to content
This repository was archived by the owner on Jul 8, 2023. It is now read-only.

Commit 4fd07b4

Browse files
committed
Repo maintenance.
1 parent e10db4b commit 4fd07b4

File tree

14 files changed

+74
-72
lines changed

14 files changed

+74
-72
lines changed

.gitattributes

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
.gitattributes export-ignore
22
.gitignore export-ignore
3-
/scripts/ export-ignore
43
/test/ export-ignore

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
sudo: false
22
language: node_js
3-
node_js: ["0.10", "0.12", "4.0", "4.1", "5.0", "iojs"]
4-
script: scripts/coverage
3+
node_js: ["4", "5", "6"]
4+
script: make ci
55
after_script: node_modules/codecov.io/bin/codecov.io.js < coverage/lcov.info

CONTRIBUTING.md

Lines changed: 15 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,19 @@
11
# Contributing
22

3-
**CouchDB builder** is open source software; contributions from the community are
4-
encouraged. Please take a moment to read these guidelines before submitting
5-
changes.
6-
7-
## Tests
8-
9-
- Run the tests with `bin/test path/to/tests`, or simply `bin/test` to run the
10-
entire suite.
11-
- Generate a coverage report with `bin/coverage` The coverage report will be
12-
created at `coverage/lcov-report/index.html`.
13-
14-
## Code style
15-
16-
Running the test suite will also check for code style. If you are submitting a
17-
pull request, please make sure no errors or warnings are produced.
18-
19-
Yes, I use 4 spaces for CoffeeScript. Yes, I know that's non-standard.
20-
21-
## Branching and pull requests
22-
23-
As a guideline, please follow this process:
3+
As a guideline, please follow this process when contributing:
244

255
1. [Fork the repository].
26-
2. Create a topic branch for the change, branching from **develop**
27-
(`git checkout -b branch-name develop`).
28-
3. Make the relevant changes.
29-
4. [Squash] commits if necessary (`git rebase -i develop`).
30-
5. Submit a pull request to the **develop** branch.
31-
32-
[Fork the repository]: https://help.github.com/articles/fork-a-repo
33-
[Squash]: http://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
6+
2. Create a branch from **master** (`git checkout -b branch-name master`).
7+
3. Make the relevant code changes.
8+
4. If your change will require documentation updates, include them in the same
9+
pull request.
10+
5. Use the various quality checks provided:
11+
- Run the tests with `make test`.
12+
- Generate a coverage report with `make coverage`, then open
13+
`coverage/lcov-report/index.html`.
14+
- Check for code style issues with `make lint`.
15+
6. [Squash] commits if necessary (`git rebase -i master`).
16+
7. Submit a pull request to the **master** branch.
17+
18+
[fork the repository]: https://help.github.com/articles/fork-a-repo
19+
[squash]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages

Makefile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
lib: node_modules $(shell find src)
2+
rm -rf lib
3+
node_modules/.bin/coffee --output lib --compile src
4+
5+
test: node_modules
6+
node_modules/.bin/mocha test/suite
7+
8+
coverage: node_modules
9+
node_modules/.bin/mocha --require test/coverage test/suite
10+
node_modules/.bin/istanbul report
11+
12+
lint: node_modules
13+
node_modules/.bin/coffeelint --file coffeelint.json src
14+
node_modules/.bin/coffeelint --file test/coffeelint.json test/suite
15+
16+
ci: coverage
17+
18+
.PHONY: test coverage lint ci
19+
20+
node_modules:
21+
npm install

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
[![Current build status image][build-image]][current build status]
77
[![Current coverage status image][coverage-image]][current coverage status]
88

9-
[build-image]: http://img.shields.io/travis/eloquent/couchdb-builder/develop.svg?style=flat-square "Current build status for the develop branch"
10-
[coverage-image]: https://img.shields.io/codecov/c/github/eloquent/couchdb-builder/develop.svg?style=flat-square "Current test coverage for the develop branch"
9+
[build-image]: http://img.shields.io/travis/eloquent/couchdb-builder/master.svg?style=flat-square "Current build status for the master branch"
10+
[coverage-image]: https://img.shields.io/codecov/c/github/eloquent/couchdb-builder/master.svg?style=flat-square "Current test coverage for the master branch"
1111
[current build status]: https://travis-ci.org/eloquent/couchdb-builder
1212
[current coverage status]: https://codecov.io/github/eloquent/couchdb-builder
1313
[current version]: https://www.npmjs.com/package/couchdb-builder

package.json

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,25 @@
2929
"test": "scripts/test"
3030
},
3131
"engines": {
32-
"node": ">= 0.10.0",
33-
"npm": ">= 1.0.0"
32+
"node": ">= 4",
33+
"npm": ">= 1"
3434
},
3535
"dependencies": {
36-
"bluebird": "^3.1.5",
37-
"readdirp": "^2.0.0"
36+
"bluebird": "^3",
37+
"readdirp": "^2"
3838
},
3939
"optionalDependencies": {
40-
"coffee-script": "^1.10.0"
40+
"coffee-script": "^1"
4141
},
4242
"devDependencies": {
43-
"chai": "^3.5.0",
43+
"chai": "^3",
4444
"codecov.io": "^0.1.6",
45-
"coffee-coverage": "^1.0.1",
46-
"coffee-script": "^1.10.0",
47-
"coffeelint": "^1.14.2",
48-
"istanbul": "^0.4.2",
49-
"mocha": "^2.4.5",
50-
"sinon": "^1.17.3"
45+
"coffee-coverage": "^1",
46+
"coffee-script": "^1",
47+
"coffeelint": "^1",
48+
"istanbul": "^0.4",
49+
"mocha": "^2",
50+
"sinon": "^1",
51+
"sinon-chai": "^2"
5152
}
5253
}

scripts/build

Lines changed: 0 additions & 6 deletions
This file was deleted.

scripts/coverage

Lines changed: 0 additions & 7 deletions
This file was deleted.

scripts/lint

Lines changed: 0 additions & 6 deletions
This file was deleted.

scripts/test

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)