Project improvements #20
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
license
Outdated
| @@ -0,0 +1,7 @@ | |||
| ISC License | |||
There was a problem hiding this comment.
I thought so too, but previously it was "ISC" in package.json, so maybe there was a reason for it.
|
Currently this PR is blocked by #18, which also modifies the readme. I want to change the format little bit of API docs, so it would collide. |
vadimdemedes
force-pushed
the
improvements
branch
from
4c2d539
to
3996fdd
Compare
package.json
Outdated
| "repository": "segmentio/jsonrpc2", | ||
| "author": { | ||
| "name": "Segment", | ||
| "email": "tools+npm@segment.com", |
There was a problem hiding this comment.
probably want friends@ for this
vadimdemedes
force-pushed
the
improvements
branch
from
3996fdd
to
a708c25
Compare
added 11 commits
July 31, 2017 22:59
vadimdemedes
force-pushed
the
improvements
branch
from
a708c25
to
3ca825b
Compare
|
I updated the readme to have a new format for API docs. I had to force push, so that the commit history is clean and we can later revert any of those changes without having to revert the whole PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is very similar to the one in analytics-node.
1. Add editorconfig
Ensures that all contributors write code with the same formatting according to the
standardlinter. Requireseditorconfigplugin to be installed in the user's editor, but experience shows most of them have it.2. Remove yarn.lock and disable npm package locks (
package-lock.json)Those are ignored by both Yarn and npm anyway, so there's no reason to include them into repository. Package locks make sense in apps, not libraries. See sindresorhus/ama#479 (comment) for a more detailed explanation.
3. Improve package.json
This change reorganizes fields in package.json to the "right" order and adds many useful things. Foe example, I added a
filesfield (https://docs.npmjs.com/files/package.json#files) to include onlyindex.jsin npm package.4. Add license
Previously there was no license specified, except in package.json. I pasted license to
licensefile (not.md, since it's not markdown, but plain text), which brings useful things to our repository, such as:and
5. Remove caching of dependencies on CI
It's always preferable for CI builds to be fresh, without any previous state. Sometimes this helps to catch some nasty bugs related to dependencies.
6. Test on multiple Node.js versions on CI
This one is pretty explanatory, previously tests ran only for Node.js v4.x.x.
7. Remove continuous deployment
After talking with @stevenmiller888, we agreed that np should be used for publishing new releases.
8. Use npm scripts instead of Makefile
Makefiles are great, but in this case the whole Makefile can be replaced with a one line in package.json.
9. Remove unused dependencies
Bluebird wasn't used but was still specified as a dependency. Bye! Same for istanbul.
WIP - 10. Improve readme
Just prettify all the things.