From 0122a5af3145976bbbb63522b03ba030fa2f2a1d Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Mon, 21 Nov 2016 21:20:43 -0200 Subject: [PATCH 1/3] Remove outdated readme --- docs/README.md | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 249cf86..0000000 --- a/docs/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# Vue.js Material Docs - -> Material Design for Vue.js - -## Build Setup - -``` bash -### install dependencies -npm install - -### serve with hot reload at localhost:8080 -npm run dev - -### build for production with minification -npm run build - -### run unit tests -npm run unit - -### run e2e tests -npm run e2e - -### run all tests -npm test -``` - -For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader). From d83ac02851eabfe7cc771b15feee57bb34c5c2e5 Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Mon, 21 Nov 2016 21:22:54 -0200 Subject: [PATCH 2/3] Create .github files and improve readme --- .github/CONTRIBUTING.md | 64 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 45 ++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 4 ++ README.md | 40 ++++++++++---------- 4 files changed, 132 insertions(+), 21 deletions(-) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..4525366 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# Vue Material Contributing Guide + +Before submitting your contribution please read the guidelines. + +- [Issue Reporting Guidelines](#issue-reporting-guidelines) +- [Pull Request Guidelines](#pull-request-guidelines) +- [Development Setup](#development-setup) + +## Issue Reporting Guidelines + +- Always search for your issue first. It may have already been answered, planned or fixed in some branch. New components and features will be planned on [Milestones](https://github.com/marcosmoura/vue-material/milestones) or on [Projects](https://github.com/marcosmoura/vue-material/projects). + +- Only create issues for the newest version. For now. Until 1.0.0. + +- Create a declarative title and describe clearly the steps necessary to reproduce the issue. If an issue labeled "need repro" receives no further input from the issue author for more than 3 days, it will be closed. + +- If you want to show your code please use [Codepen](http://codepen.io/pen/) or [JSFiddle](https://jsfiddle.net/). You could start with [this template](http://codepen.io/vue-material/pen/WGavBE). + +- In case you found a solution by yourself try to explain how you fixed it. It could be useful for somebody else. :) + +## Pull Request Guidelines + +- The `master` branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.** + +- Work in the `src` or `docs` folder and **DO NOT** add `dist` in the commits. + +- Make small commits as you work on the PR. They will be automatically squashed before merging. + +- Provide convincing reason to add a new feature. Ideally you should open a suggestion/request issue first and have it greenlighted before working on it. + +- If fixing a bug: + - If you are resolving a special issue, add the GitHub ID to your commit. E.g. `(fix something really ugly #xxx)` + - Provide detailed description of the bug in the PR. + +## Development Setup + +You will need [Node.js](http://nodejs.org) **version 6+** + +After cloning the repo, run: + +``` bash +$ npm install +``` + +### Commonly used NPM scripts + +``` bash +### Start dev server with hot reload +npm run dev + +### Check for errors +npm run lint + +### Build everything +npm run build + +### Build docs only +npm run build:docs + +### Build lib only +npm run build:lib +``` + +The other tasks on package.json **SHOULD NOT** be executed. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2a75dc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,45 @@ + + + + +### Steps to reproduce + +### Which browser? + + +### What is expected? + +### What is actually happening? + + +### Reproduction Link + + diff --git a/README.md b/README.md index 1c5981b..b23d824 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ -# Vue.js Material +

+ + + +

-> Material Design for Vue.js +

Material Design for Vue.js

+ +

+ Downloads + + Version + + License +

+ +
Vue Material is lightweight framework built exactly according to the Material Design specs. It aims to deliver a collection of reusable components and a series of UI Elements to build applications with support to modern Web Browsers through Vue 2.0. Build powerful and well-designed web apps that can can fit on every screen. You can generate and use themes dynamically, use components on demand, take advantage of UI Elements and Components with an ease-to-use API. @@ -9,7 +23,7 @@ Vue Material is lightweight framework built exactly according to the @@ -92,25 +106,9 @@ Apply your theme using v-md-theme directive: ## Changelog Changelog -## Build Setup +## Contributing -``` bash -### Install dependencies -npm install -yarn - -### Start dev server with hot reload -npm run dev - -### Build everything -npm run build - -### Build docs only -npm run build:docs - -### Build lib only -npm run build:lib -``` +Please make sure to read the [Contributing Guide](https://github.com/marcosmoura/vue-material/blob/master/.github/CONTRIBUTING.md) before making a pull request. ## Credits and Thanks * This library aims to delivery components using almost the same API of Angular Material From 9cec300e2d8faa91f95ae3402a9fc4f089611520 Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Mon, 21 Nov 2016 21:23:36 -0200 Subject: [PATCH 3/3] Remove extra space --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index b23d824..9ba773d 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,9 @@ Version - License + License

-
- Vue Material is lightweight framework built exactly according to the Material Design specs. It aims to deliver a collection of reusable components and a series of UI Elements to build applications with support to modern Web Browsers through Vue 2.0. Build powerful and well-designed web apps that can can fit on every screen. You can generate and use themes dynamically, use components on demand, take advantage of UI Elements and Components with an ease-to-use API. ## Demo and Documentation