Merge pull request #81 from dsafio/node-versions-and-tweaks

joeljuca · web-flow · commit 8e37f1936f1b · 2020-07-01T23:57:51.000-03:00
Drop support for Node.js versions 8 and 9
diff --git a/.travis.yml b/.travis.yml
@@ -1,13 +1,12 @@
 language: node_js
 node_js:
-  - "8"
-  - "9"
   - "10"
-  - "11"
+  - "12"
+  - "14"
+  - "node"
 cache:
   directories:
     - "node_modules"
 script:
-- "npm run lint"
-- "npm test"
-
+  - "npm run lint"
+  - "npm test"
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   "bugs": "https://github.com/dsafio/dsafio/issues",
   "license": "MIT",
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=10.0.0"
   },
   "files": [
     "bin",
diff --git a/readme.md b/readme.md
@@ -2,17 +2,16 @@
 
 [![Travis CI](https://travis-ci.org/dsafio/dsafio.svg?branch=master)](https://travis-ci.org/dsafio/dsafio)
 [![Snyk](https://snyk.io/test/github/dsafio/dsafio/badge.svg)](https://snyk.io/test/github/dsafio/dsafio)
-[![Greenkeeper](https://badges.greenkeeper.io/dsafio/dsafio.svg)](https://greenkeeper.io/)
 
 Practicing tool for coders.
 
 ## Up and Running 🏃
 
-It's a [commander](https://github.com/tj/commander.js) powered [Node.js](https://nodejs.org) CLI.
+It's a [Commander.js](https://github.com/tj/commander.js) powered [Node.js](https://nodejs.org) CLI.
 
 **Requirements**
 
-You need Node.js to run the CLI. We recommend [Node Version Manager](https://github.com/creationix/nvm) to manage your Node.js environment.
+You need Node.js to run the CLI. We recommend [asdf](https://asdf-vm.com) to manage your Node.js environment.
 
 **Install the CLI**
 
@@ -22,6 +21,8 @@ npm install -g dsafio
 
 ## Contributing 👷
 
+Dsafio is a Node.js command-line tool. You'll want to have the development version of the `dsafio` command in your `$PATH`. Besides it, it will feel like a normal Node.js project for you. It's built with [Commander.js](https://github.com/tj/commander.js), tested with [Mocha](https://mochajs.org), [Chai](https://www.chaijs.com) and [Sinon.JS](https://sinonjs.org), with [Prettier](https://prettier.io) as coding standard.
+
 **Development environment**
 
 Depending on how is your `$PATH`, you might need to uninstall `dsafio` as global:
@@ -44,31 +45,32 @@ npm link
 
 `dsafio` command should now be available in your shell.
 
-**Contribution workflow**
+**Unlinking the development version**
 
-There are steps that you need to take before being able to start to
-contribute:
+If you ever need to unlink the global version (eg.: you want to install the production version directly from npm), you will want to unlink the development version first:
 
-1. Fork the repository (if you haven't yet)
-1. Clone your fork in your local machine
+```
+npm unlink
+```
 
-Then:
+**Conventional Commits**
 
-1. Find an issue to work on in our [issue tracker](https://github.com/dsafio/dsafio/issues)  
-   _If it's a new bug or feature, [create a new one](https://github.com/dsafio/dsafio/issues/new) and describe it in detail_
-1. Create a new branch to work on  
-   _`git checkout -b user-page-not-loading`_
-1. Commit your work  
-   _One commit per contribution (use `git commit --amend`)_
-1. Open a pull request and go through the review process
-1. Get your contribution accepted
+We use [Conventional Commits](https://www.conventionalcommits.org) in our commit history. It is a specification for commit messages that help us automate versioning processes. Please refer to its website for more information.
 
 ## Testing ✅
 
+Test can be run with the following command:
+
 ```
 npm test
 ```
 
+It's possible to run them in watch mode:
+
+```
+npm run test:watch
+```
+
 ## Style Guide 🌷
 
 We use [Prettier](https://prettier.io).
