Skip to content

Commit a67a4b8

Browse files
committed
📝 docs: updates
1 parent d90976c commit a67a4b8

File tree

5 files changed

+75
-13
lines changed

5 files changed

+75
-13
lines changed

.github/CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# vue-i18n-locale-message Contributing Guide
2+
3+
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
4+
- [Pull Request Guidelines](#pull-request-guidelines)
5+
- [Development Setup](#development-setup)
6+
7+
## Issue Reporting Guidelines
8+
9+
- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be closed immediately.
10+
11+
- Try to search for your issue, it may have already been answered or even fixed in the master branch.
12+
13+
- Check if the issue is reproducible with the latest stable version of vue-i18n-locale-message. If you are using a pre-release, please indicate the specific version you are using.
14+
15+
- 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 `Status: Need More Info` receives no further input from the issue author for more than 5 days, it will be closed.
16+
17+
- For bugs that involves build setups, you can create a reproduction repository with steps in the README.
18+
19+
- 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.
20+
21+
## Pull Request Guidelines
22+
23+
- Checkout a topic branch from the `master` branch.
24+
25+
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.
26+
27+
- Make sure `npm test` passes. (see [development setup](#development-setup))
28+
29+
- If adding new feature:
30+
- Add accompanying test case.
31+
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
32+
33+
- If fixing a bug:
34+
- Provide detailed description of the bug in the PR.
35+
- Add appropriate test coverage if applicable.
36+
37+
### Work Step Example
38+
- Fork the repository from [kazupon/vue-i18n-locale-message](https://github.com/kazupon/vue-i18n-locale-message) !
39+
- Create your topic branch from `master`: `git branch my-new-topic origin/master`
40+
- Add codes and pass tests !
41+
- Commit your changes: `git commit -am 'Add some topic'`
42+
- Push to the branch: `git push origin my-new-topic`
43+
- Submit a pull request to `master` branch of `kazupon/vue-i18n-locale-message` repository !
44+
45+
## Development Setup
46+
47+
After cloning the repo, run:
48+
49+
$ npm install
50+
51+
### Commonly used NPM scripts
52+
53+
# lint source codes
54+
$ npm run lint
55+
56+
# run the full test suite, include linting
57+
$ npm test
58+
59+
There are some other scripts available in the `scripts` section of the `package.json` file.
60+
61+
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.
62+

.github/ISSUE_TEMPLATE.md

Whitespace-only changes.

.github/PULL_REQUEST_TEMPLATE.md

Whitespace-only changes.

CHANEGLOG.md

Whitespace-only changes.

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# vue-i18n-locale-message
1+
# :globe_with_meridians: vue-i18n-locale-message
22

33
i18n locale messages management tool / library for vue-i18n
44

5+
<a href="https://www.patreon.com/kazupon" target="_blank">
6+
<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patreon">
7+
</a>
8+
59
## :cd: Installation
610

711
### npm
@@ -181,19 +185,15 @@ You will get the following JSON structure (the following output results are comm
181185
}
182186
```
183187

188+
## :scroll: Changelog
189+
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/vue-i18n-locale-message/blob/master/CHANGELOG.md).
190+
191+
192+
## :exclamation: Issues
193+
Please make sure to read the [Issue Reporting Checklist](https://github.com/kazupon/vue-i18n-locale-mesasge/blob/master/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
194+
184195
## :white_check_mark: TODO
185-
- [x] API design
186-
- [x] extract locale messages from SFC
187-
- [x] infuse to SFC from locale mesasges
188-
- [x] CLI tool
189-
- [ ] integrate vue-cli-plugin-i18n
190-
- [ ] documentation
191-
- [ ] duplicate locale message keys checking
192-
- [ ] rollup duplicate locale messages
193-
- [ ] delete duplicate locale messages
194-
- [ ] caml/snake case option of locale messages hierarcy name for squeezer
195-
- [ ] sort option for locale messages keys for squeezer
196-
- [ ] locale message yaml outputing
196+
Managed with [GitHub Projects](https://github.com/kazupon/vue-i18n-locale-message/issues?q=is%3Aissue+is%3Aopen+label%3Atodo)
197197

198198
## :copyright: License
199199

0 commit comments

Comments
 (0)