Skip to content

Commit

Permalink
style(markdown): Add markdownlint dep and a package script
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdo2
mdo2 committed Apr 9, 2018
1 parent d2d8097 commit 0b315c1
Show file tree
Hide file tree
Showing 5 changed files with 120 additions and 37 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Contributing to this project

All you need to know about how to contribute is at
[development flow documentation](docs/dev-flow.md) that explain the way to work at the
project.
[development flow documentation](docs/dev-flow.md) that explain the way to work
at the project.
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@

> The VueJS version of the PollMe webapp
This is the awesome app with with you be able to collect in the most easy way any kind of
opinion or preferece from anyone.
This is the awesome app with with you be able to collect in the most easy way
any kind of opinion or preferece from anyone.

For example:

Expand All @@ -33,8 +33,8 @@ and [docs for vue-loader](http://vuejs.github.io/vue-loader).

## Start working with the project

To contribute you just need to clone the repo and install the node dependencies, then you
can run any package script.
To contribute you just need to clone the repo and install the node dependencies,
then you can run any package script.

```bash
# Clone the repo and enter inside
Expand All @@ -51,12 +51,13 @@ npm start

## Development flow

You must follow [this](docs/dev-flow.md) guidelines in order to contribute to the project in any way.
You must follow [this](docs/dev-flow.md) guidelines in order to contribute to
the project in any way.

## Package scripts

As the project do not have a task builder like Grunt or Gulp we need to use the npm package scripts
to run the tasks that manage the workflow of the project.
As the project do not have a task builder like Grunt or Gulp we need to use the
npm package scripts to run the tasks that manage the workflow of the project.

``` bash
# serve with hot reload at localhost:8080
Expand Down
53 changes: 28 additions & 25 deletions docs/dev-flow.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Development flow

The project follow the **Git flow** model wich be based on Vicent Driessen model that you
can see the original post [here](http://nvie.com/posts/a-successful-git-branching-model/)
The project follow the **Git flow** model wich be based on Vicent Driessen
model that you can see the original post [here](http://nvie.com/posts/a-successful-git-branching-model/)
or a quick guide [here](http://danielkummer.github.io/git-flow-cheatsheet/).

- [Main branches](#main-branches)
Expand All @@ -13,48 +13,50 @@ or a quick guide [here](http://danielkummer.github.io/git-flow-cheatsheet/).
- [Release (`release/`)](#release-release)
- [Version flow](#version-flow)

Well, this docs will explain the basis of the concept of **Git flow** applied to this project, the
main concepts are:
Well, this docs will explain the basis of the concept of **Git flow** applied
to this project, the main concepts are:

- We have 2 main branches (`develop` and `master`)
- We use 4 different support branches identified by prefixes
- We use **code review** (Merge requests) for **ALL** merge commits
- We always publish the branches we are working on, _we never work alone_
- The commit messages are very important, **DO NOT use generic messages** like _Minor bug fixes_
- The commit messages are very important, **DO NOT use generic messages** like
_Minor bug fixes_

![Git flow banching model](http://nvie.com/img/git-model@2x.png)

## Main branches

This branches are static to the project and are the representation of project main history
because all the things start from this branches and end at this branches.
This branches are static to the project and are the representation of project
main history because all the things start from this branches and end at this branches.

### Develop

This is the development integration branch where all the current features start
and ends before release. All the things developed but hotfixes **MUST START FROM DEVELOP**.
and ends before release. All the things developed but hotfixes
**MUST START FROM DEVELOP**.

When the changes at develop are enought to make another version of the project a new
release branch are created to manage the new version.

The success commits in this brach are deployed to the [dev enviroment](http://eqonecta.tsurudev.qdqmedia.com/).
When the changes at develop are enought to make another version of the project
a new release branch are created to manage the new version.

### Master

The main branch of the project, **direct commits are FORBIDDEN** the changes to this branch are made
by code review merge request from `hotfix` or `release` branches and are always tagged with a version
number following the [version flow](#version-flow) of the project.
The main branch of the project, **direct commits are FORBIDDEN** the changes to
this branch are made by code review merge request from `hotfix` or `release`
branches and are always tagged with a version number following the
[version flow](#version-flow) of the project.

The success commit of this branch are automatically deployed at beta enviroment.

## Support branches

This kind of branches are the the way to make any changes on the project, depending the change you want
to do you should create a type of support branch or another. All support branches are prefixed with
the identifier of the branch kind.
This kind of branches are the the way to make any changes on the project,
depending the change you want to do you should create a type of support branch
or another. All support branches are prefixed with the identifier of the branch
kind.

The branch name have to follow **CapitalCase convention**, for example: `feature/AwesomeComponent` or
`hotfix/FixApiEndpoint`.
The branch name have to follow **CapitalCase convention**, for example:
`feature/AwesomeComponent` or `hotfix/FixApiEndpoint`.

### Feature (`feature/`)

Expand All @@ -64,9 +66,9 @@ that starts and ends at `develop` by a merge request.

### Hotfix (`hotfix/`)

This kind of branch is used for making important but small changes needed for production and always implict
a version upgrade of the project that must be a path, speaking in
[semantic versioning](http://semver.org/) terms.
This kind of branch is used for making important but small changes needed for
production and always implict a version upgrade of the project that must be a
path, speaking in [semantic versioning](http://semver.org/) terms.

This branches always **HAVE TO END** commited to main branches.

Expand All @@ -75,8 +77,9 @@ This branches always **HAVE TO END** commited to main branches.
Integration branches for grouping all the changes made at the new version
and do all the new [version flow](#version-flow) which is explained down below.

The name of this branch must be the number of the intended version to release, for example,
if the future version would be the `1.2.3` the release branch name would be `release/1.2.3`.
The name of this branch must be the number of the intended version to release,
for example, if the future version would be the `1.2.3` the release branch name
would be `release/1.2.3`.

## Version flow

Expand Down
5 changes: 4 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@
"unit": "jest --config test/unit/jest.conf.js --coverage",
"e2e": "node test/e2e/runner.js",
"test": "npm run unit && npm run e2e",
"lint": "eslint --ext .js,.vue src test/unit test/e2e/specs",
"lint": "npm run lint:js && npm run lint:md",
"lint:js": "eslint --ext .js,.vue src test/unit test/e2e/specs",
"lint:md": "markdownlint *.md docs/**",
"build": "node build/build.js"
},
"dependencies": {
Expand Down Expand Up @@ -68,6 +70,7 @@
"html-webpack-plugin": "^2.30.1",
"jest": "^22.0.4",
"jest-serializer-vue": "^0.3.0",
"markdownlint-cli": "^0.8.1",
"nightwatch": "^0.9.12",
"node-notifier": "^5.1.2",
"optimize-css-assets-webpack-plugin": "^3.2.0",
Expand Down
79 changes: 77 additions & 2 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1682,7 +1682,7 @@ commander@2.15.x, commander@^2.13.0, commander@^2.9.0, commander@~2.15.0:
version "2.15.1"
resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"

commander@2.9.0:
commander@2.9.0, commander@~2.9.0:
version "2.9.0"
resolved "https://registry.yarnpkg.com/commander/-/commander-2.9.0.tgz#9c99094176e12240cb22d6c5146098400fe0f7d4"
dependencies:
Expand Down Expand Up @@ -2101,7 +2101,7 @@ deep-equal@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/deep-equal/-/deep-equal-1.0.1.tgz#f5d260292b660e084eff4cdbc9f08ad3247448b5"

deep-extend@~0.4.0:
deep-extend@~0.4.0, deep-extend@~0.4.1:
version "0.4.2"
resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.4.2.tgz#48b699c27e334bf89f10892be432f6e4c7d34a7f"

Expand Down Expand Up @@ -3207,6 +3207,10 @@ get-stdin@^4.0.1:
version "4.0.1"
resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-4.0.1.tgz#b968c6b0a04384324902e8bf1a5df32579a450fe"

get-stdin@~5.0.1:
version "5.0.1"
resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-5.0.1.tgz#122e161591e21ff4c52530305693f20e6393a398"

get-stream@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-3.0.0.tgz#8e943d1358dc37555054ecbe2edb05aa174ede14"
Expand Down Expand Up @@ -3274,6 +3278,17 @@ glob@^7.0.0, glob@^7.0.3, glob@^7.0.5, glob@^7.1.1, glob@^7.1.2:
once "^1.3.0"
path-is-absolute "^1.0.0"

glob@~7.0.3:
version "7.0.6"
resolved "https://registry.yarnpkg.com/glob/-/glob-7.0.6.tgz#211bafaf49e525b8cd93260d14ab136152b3f57a"
dependencies:
fs.realpath "^1.0.0"
inflight "^1.0.4"
inherits "2"
minimatch "^3.0.2"
once "^1.3.0"
path-is-absolute "^1.0.0"

globals@^11.0.1, globals@^11.1.0:
version "11.4.0"
resolved "https://registry.yarnpkg.com/globals/-/globals-11.4.0.tgz#b85c793349561c16076a3c13549238a27945f1bc"
Expand Down Expand Up @@ -4590,6 +4605,12 @@ levn@^0.3.0, levn@~0.3.0:
prelude-ls "~1.1.2"
type-check "~0.3.2"

linkify-it@^2.0.0:
version "2.0.3"
resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-2.0.3.tgz#d94a4648f9b1c179d64fa97291268bdb6ce9434f"
dependencies:
uc.micro "^1.0.1"

load-json-file@^1.0.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/load-json-file/-/load-json-file-1.1.0.tgz#956905708d58b4bab4c2261b04f59f31c99374c0"
Expand Down Expand Up @@ -4743,6 +4764,14 @@ lodash.defaultsdeep@4.3.2:
lodash.mergewith "^4.0.0"
lodash.rest "^4.0.0"

lodash.differencewith@~4.5.0:
version "4.5.0"
resolved "https://registry.yarnpkg.com/lodash.differencewith/-/lodash.differencewith-4.5.0.tgz#bafafbc918b55154e179176a00bb0aefaac854b7"

lodash.flatten@~4.4.0:
version "4.4.0"
resolved "https://registry.yarnpkg.com/lodash.flatten/-/lodash.flatten-4.4.0.tgz#f31c22225a9632d2bbf8e4addbef240aa765a61f"

lodash.get@^3.7.0:
version "3.7.0"
resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-3.7.0.tgz#3ce68ae2c91683b281cc5394128303cbf75e691f"
Expand Down Expand Up @@ -4876,6 +4905,35 @@ map-visit@^1.0.0:
dependencies:
object-visit "^1.0.0"

markdown-it@8.4.1:
version "8.4.1"
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-8.4.1.tgz#206fe59b0e4e1b78a7c73250af9b34a4ad0aaf44"
dependencies:
argparse "^1.0.7"
entities "~1.1.1"
linkify-it "^2.0.0"
mdurl "^1.0.1"
uc.micro "^1.0.5"

markdownlint-cli@^0.8.1:
version "0.8.1"
resolved "https://registry.yarnpkg.com/markdownlint-cli/-/markdownlint-cli-0.8.1.tgz#b5644bdc52635827097ac1829b4be54d9c94637c"
dependencies:
commander "~2.9.0"
deep-extend "~0.4.1"
get-stdin "~5.0.1"
glob "~7.0.3"
lodash.differencewith "~4.5.0"
lodash.flatten "~4.4.0"
markdownlint "~0.8.1"
rc "~1.1.6"

markdownlint@~0.8.1:
version "0.8.1"
resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.8.1.tgz#a87572ccc84273b2a723205e65fa657437fe06c6"
dependencies:
markdown-it "8.4.1"

math-expression-evaluator@^1.2.14:
version "1.2.17"
resolved "https://registry.yarnpkg.com/math-expression-evaluator/-/math-expression-evaluator-1.2.17.tgz#de819fdbcd84dccd8fae59c6aeb79615b9d266ac"
Expand All @@ -4887,6 +4945,10 @@ md5.js@^1.3.4:
hash-base "^3.0.0"
inherits "^2.0.1"

mdurl@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e"

media-typer@0.3.0:
version "0.3.0"
resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
Expand Down Expand Up @@ -6231,6 +6293,15 @@ rc@^1.1.7:
minimist "^1.2.0"
strip-json-comments "~2.0.1"

rc@~1.1.6:
version "1.1.7"
resolved "https://registry.yarnpkg.com/rc/-/rc-1.1.7.tgz#c5ea564bb07aff9fd3a5b32e906c1d3a65940fea"
dependencies:
deep-extend "~0.4.0"
ini "~1.3.0"
minimist "^1.2.0"
strip-json-comments "~2.0.1"

read-cache@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/read-cache/-/read-cache-1.0.0.tgz#e664ef31161166c9751cdbe8dbcf86b5fb58f774"
Expand Down Expand Up @@ -7379,6 +7450,10 @@ typedarray@^0.0.6:
version "0.0.6"
resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"

uc.micro@^1.0.1, uc.micro@^1.0.5:
version "1.0.5"
resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.5.tgz#0c65f15f815aa08b560a61ce8b4db7ffc3f45376"

uglify-es@^3.3.4:
version "3.3.9"
resolved "https://registry.yarnpkg.com/uglify-es/-/uglify-es-3.3.9.tgz#0c1c4f0700bed8dbc124cdb304d2592ca203e677"
Expand Down

0 comments on commit 0b315c1

Please sign in to comment.