-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial version of the repository with a working Vuetify and Storybook integration. In addition it has the following tools setup: commitizen, commitlint, markdown-toc, Travis CI, Greenkeeper and release-it.
- Loading branch information
nidkil
committed
Jan 18, 2019
1 parent
c61c62c
commit 304586c
Showing
38 changed files
with
8,931 additions
and
2,634 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# EditorConfig is awesome: http://EditorConfig.org | ||
|
||
# top-most EditorConfig file | ||
root = true | ||
|
||
[*] | ||
# Unix-style newlines with a newline ending every file and trim trailing white spaces | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
# 2 space indentation | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
# Set default charset | ||
[*.{js,vue}] | ||
charset = utf-8 |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
module.exports = { | ||
semi: false, | ||
printWidth: 120, | ||
singleQuote: true | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"increment": "conventional:angular", | ||
"scripts" : { | ||
"beforeStart": "npm run test:unit && npm run lint:error-only", | ||
"afterBump": "conventional-changelog -p angular -i CHANGELOG.md -s", | ||
"beforeStage": "npm run build", | ||
"changelog": "conventional-changelog -p angular | tail -n +3" | ||
}, | ||
"git" : { | ||
"commitMessage": "chore: release ${version}", | ||
"tagName": "v${version}", | ||
"tagAnnotation": "Release v${version}" | ||
}, | ||
"npm": { | ||
"publish": false | ||
}, | ||
"github": { | ||
"release": true, | ||
"releaseName": "🚀 Release ${version}", | ||
"tokenRef": "GITHUB_TOKEN" | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
os: | ||
- linux | ||
language: node_js | ||
node_js: | ||
- "8" | ||
- "10" | ||
- "node" | ||
sudo: false | ||
cache: | ||
- "packages" | ||
script: | ||
- npm test:unit | ||
after_script: | ||
- npm run coveralls |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"hooks": { | ||
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS" | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]. | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# Contribution Guidelines | ||
|
||
First of all, thanks for thinking of contributing to this project! 👏 | ||
|
||
Contributions are **welcome** and will be fully **credited**. | ||
|
||
## Code of conduct | ||
|
||
This project has a [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
||
## ❤ Ways to Contribute | ||
|
||
* Blog or tweet about the project | ||
* Improve documentation | ||
* Fix a bug | ||
* Implement a new feature | ||
* Discuss potential ways to improve project | ||
* Improve existing implementation, performance, etc. | ||
|
||
## 🛎 Questions | ||
|
||
Feel free to open a ticket with your question. | ||
|
||
Please put some effort in requesting a new feature. If someone else is going to implement something, the least you can do is describe the feature in detail, and why it would be useful to others as well. | ||
|
||
## 🐛 File a Bug | ||
|
||
In case you've encountered a bug, please make sure: | ||
|
||
* You are using the [latest version](https://github.com/nidkil/vuetify-with-storybook/releases). | ||
* You have read the [documentation](https://github.com/nidkil/vuetify-with-storybook/blob/master/README.md) first, and double-checked your configuration. | ||
* You have acknowledged from `--verbose` and `--debug` the errors are likely a bug in this project (and not coming from your environment or a dependency of this project). | ||
* In your issue description, please include: | ||
* What you expected to see, and what happened instead. | ||
* Your operating system and other environment information by running `info`. | ||
* As much information as possible, such as the command and configuration used. | ||
* Interesting logs with `--verbose` and/or `--debug`. | ||
* All steps to reproduce the issue. | ||
|
||
## 🎁 Pull Requests | ||
|
||
We accept contributions via Pull Requests on [Github](https://github.com/nidkil/vue-build-helper). | ||
|
||
Please keep the following in mind: | ||
|
||
* See below for instructions on how to set up the project on your machine. | ||
* To match the existing code styling, use `npm run prettier` before committing code. | ||
* Make sure the tests pass (run `npm test`). Your changes probably deserve new tests as well. | ||
* Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different versions of Node. | ||
|
||
Unsure about whether you should open a pull request? Feel free to discuss it first in a ticket. | ||
|
||
Somethings to keep in mind | ||
|
||
- **Keep the same style** - eslint will automatically be run before committing. | ||
|
||
**Tip**: To pass lint tests easier use the `npm run lint:fix` command. | ||
|
||
- **Add tests!** - Your contribution will not be accepted if it does not have accompanying tests. | ||
|
||
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. | ||
|
||
- **Consider our release cycle** - We follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. | ||
|
||
- **Create feature branches** - Don't ask us to pull from your master branch. Always create a separate branch for any change. | ||
|
||
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. | ||
|
||
- **Send coherent history** - We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) standard for commit message and use tooling to simplify conforming with and enforcing the standard. Ensure you provide meaning full commit messages! Use the tooling that the project provides. | ||
|
||
**Tip**: To commit use the `npm run commit` command, this is an interactive commit command that ensures that the commit complies with the Conventional Commits standard. | ||
|
||
## Set up the project on your machine | ||
|
||
First fork the the project on [GitHub](). | ||
|
||
```bash | ||
git clone https://github.com/nidkil/vuetify-with-storybook | ||
cd vuetify-with-storybook | ||
npm install | ||
``` | ||
|
||
Verify the tests are passing: | ||
|
||
``` | ||
npm test | ||
``` | ||
|
||
Lint the project: | ||
|
||
``` | ||
npm run lint | ||
``` | ||
|
||
To make vuetify-with-storybook globally available so you can run it on your (test) project(s): | ||
|
||
``` | ||
npm link | ||
``` | ||
|
||
**Happy coding**! | ||
|
||
## License | ||
|
||
Released under the [MIT](LICENSE.md) license. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License (MIT) | ||
|
||
Copyright (c) 2018-present, nidkil <[email protected]> (https://nidkil.me) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.