Skip to content
Permalink
Browse files

🐣 release: commit first

  • Loading branch information...
kazupon committed Mar 2, 2018
0 parents commit aac00a32fd602f8ab1aacb886873ba3e90ce84d3
@@ -0,0 +1,5 @@
{
"presets": [
["env"]
]
}
@@ -0,0 +1,9 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
@@ -0,0 +1,2 @@
node_modules
template
@@ -0,0 +1,9 @@
{
"extends": ["plugin:vue-libs/recommended"],
"env": {
},
"rules": {
"indent": ["error", 2, { "MemberExpression": "off" }],
"vue-libs/no-async-functions": 2
}
}
@@ -0,0 +1,66 @@
# vue-cli-plugin-i18n Contributing Guide

- [Issue Reporting Guidelines](#issue-reporting-guidelines)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)

## Issue Reporting Guidelines

- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be closed immediately.

- For simple beginner questions, you can get quick answers from [Vue Land](https://vue-land.js.org)

- Try to search for your issue, it may have already been answered or even fixed in the development branch.

- Check if the issue is reproducible with the latest stable version of vue-cli-plugin-i18n. If you are using a pre-release, please indicate the specific version you are using.

- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.

- For bugs that involves build setups, you can create a reproduction repository with steps in the README.

- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

## 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.**

- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch.

- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.

- Make sure `npm test` passes. (see [development setup](#development-setup))

- If adding new feature:
- Add accompanying test case.
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.

- If fixing a bug:
- Provide detailed description of the bug in the PR. Live demo preferred.
- Add appropriate test coverage if applicable.

### Work Step Example
- Fork the repository from [kazupon/vue-cli-plugin-i18n](https://github.com/kazupon/vue-cli-plugin-i18n) !
- Create your topic branch from `dev`: `git branch my-new-topic origin/dev`
- Add codes and pass tests !
- Commit your changes: `git commit -am 'Add some topic'`
- Push to the branch: `git push origin my-new-topic`
- Submit a pull request to `dev` branch of `kazupon/vue-cli-plugin-i18n` repository !

## Development Setup

After cloning the repo, run:

$ npm install

### Commonly used NPM scripts

# lint source codes
$ npm run lint

# run the full test suite, include linting
$ npm test

There are some other scripts available in the `scripts` section of the `package.json` file.

The default test script will do the following: lint with ESLint -> unit tests with coverage. **Please make sure to have this pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally beforehand.

No changes.
No changes.
@@ -0,0 +1,5 @@
node_modules
.DS_Store
*.log
*.swp
*~
@@ -0,0 +1,3 @@
.*
*.log
*.swp
No changes.
20 LICENSE
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2018 kazuya kawaguchi

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.
@@ -0,0 +1,47 @@
# :globe_with_meridians: vue-cli-plugin-i18n

[![npm](https://img.shields.io/npm/v/vue-cli-plugin-i18n.svg)](https://www.npmjs.com/package/vue-cli-plugin-i18n)

Vue CLI 3.x plugin to add vue-i18n to your Vue Project

> NOTE: :warn: WIP

## :rocket: Getting Started
If yon don't have a project created with Vue CLI 3.x:

```sh
$ vue create my-vue-app
```

Install the plugin into your project:

```sh
$ cd my-vue-app
$ npm i -D vue-cli-plugin-i18n
$ # OR:
$ yarn add -D vue-cli-plugin-i18n
```

Invoke the plugin:

```sh
$ vue invoke i18n
```


## :scroll: Changelog
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/vue-cli-plugin-i18n/blob/dev/CHANGELOG.md).


## :exclamation: Issues
Please make sure to read the [Issue Reporting Checklist](https://github.com/kazupon/vue-cli-plugin-i18n/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.


## :muscle: Contribution
Please make sure to read the [Contributing Guide](https://github.com/kazupon/vue-cli-plugin-i18n/blob/dev/.github/CONTRIBUTING.md) before making a pull request.


## :copyright: License

[MIT](http://opensource.org/licenses/MIT)
@@ -0,0 +1,2 @@
module.exports = (api, options) => {
}
@@ -0,0 +1,2 @@
module.exports = (api, options) => {
}

0 comments on commit aac00a3

Please sign in to comment.
You can’t perform that action at this time.