Skip to content

Commit 33f8c54

Browse files
committed
fix: add coveralls and more docs
1 parent 98142b5 commit 33f8c54

5 files changed

Lines changed: 24 additions & 20073 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,20 @@ npm run lint:fix
3030
# Commit files with commitizen (use this instead of git commit)
3131
npm run cz
3232
```
33+
## Workflow
34+
35+
- Create a component in the src/components folder
36+
- Add tests in the src/components/\_\_tests\_\_ folder
37+
- Register this component in src/index.js
38+
- Write stories which use your component as a template in src/stories/index.stories.js
39+
- Run `npm run storybook` to author your components by having a development environment
40+
- Run lint and tests before commiting anything
41+
- Commit using [Commit Convention](.github/COMMIT_CONVENTION.md) and push to github
42+
- If deployment is setup correctly(see next section), your components will be available on npm and release on github :)
3343

3444
## Deployment
3545

36-
This repository is intended to be used with travisCI for deployment. [Semantic-release](https://github.com/semantic-release/semantic-release) is used and setup to auto-generate changelog, auto-publish to npm and auto-release to github based on commit messages structure. See [Commit Convention](.github/COMMIT_CONVENTION.md).
46+
This repository is intended to be used with travisCI for deployment. [Semantic-release](https://github.com/semantic-release/semantic-release) is used and setup to auto-generate changelog, auto-publish to npm and auto-release to github based on commit messages structure. For it to work properly you have to follow this [Commit Convention](.github/COMMIT_CONVENTION.md).
3747

3848
You may need to install [Semantic-release-cli](https://github.com/semantic-release/cli) to enable and pre-configure travisCI with npm and github tokens.
3949

.travis.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ node_js:
88
- '9'
99
- '8'
1010
after_success:
11+
- npm run coveralls
1112
- npm install -g travis-deploy-once@4
1213
- travis-deploy-once "npm run semantic-release"
1314
branches:

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
# vue-creativecommons
22

3-
[![Build Status](https://travis-ci.org/julon/vue-creativecommons.svg?branch=master)](https://travis-ci.org/julon/vue-creativecommons)
3+
![Rollup badge](https://img.shields.io/badge/Rollup-^0.53.3-ff69b4.svg)
4+
![Jest](https://img.shields.io/badge/Jest-^22.0.4-blue.svg)
5+
![Vue](https://img.shields.io/badge/Vue-^2.5.13-brightgreen.svg)
6+
![Storybook](https://img.shields.io/badge/Storybook-^3.3.3-ff70a3.svg)
7+
![Commitizen](https://img.shields.io/badge/Commitizen-enabled-brightgreen.svg)
8+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
9+
![Npm badge](https://img.shields.io/npm/v/vue-creativecommons.svg)
410
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
11+
[![Build Status](https://travis-ci.org/julon/vue-creativecommons.svg?branch=master)](https://travis-ci.org/julon/vue-creativecommons)
12+
[![Coverage Status](https://coveralls.io/repos/github/julon/vue-creativecommons/badge.svg?branch=master)](https://coveralls.io/github/julon/vue-creativecommons?branch=master)
513

614
> CreativeCommons.org Vue.js components library.
715

0 commit comments

Comments
 (0)