Skip to content

Commit c0b4527

Browse files
committed
📝 docs: add contributing guide
1 parent 4119a38 commit c0b4527

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# eslint-plugin-vue-i18n 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+
- For simple beginner questions, you can get quick answers from [`#vue-i18n` channel of Discord](https://chat.vuejs.org/)
12+
13+
- For more complicated questions, you can use [the official forum](http://forum.vuejs.org/) or StackOverflow. Make sure to provide enough information when asking your questions - this makes it easier for others to help you!
14+
15+
- Try to search for your issue, it may have already been answered or even fixed in the development branch.
16+
17+
- Check if the issue is reproducible with the latest stable version of ESLint. If you are using a pre-release, please indicate the specific version you are using.
18+
19+
- 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.
20+
21+
- For bugs that involves build setups, you can create a reproduction repository with steps in the README.
22+
23+
- 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.
24+
25+
## Pull Request Guidelines
26+
27+
- 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.**
28+
29+
- Checkout a topic branch from the relevant branch, e.g. `master`, and merge back against that branch.
30+
31+
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.
32+
33+
- Make sure `yarn test` passes. (see [development setup](#development-setup))
34+
35+
- If adding new feature:
36+
- Add accompanying test case.
37+
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
38+
39+
- If fixing a bug:
40+
- Provide detailed description of the bug in the PR. Live demo preferred.
41+
- Add appropriate test coverage if applicable.
42+
43+
### Work Step Example
44+
- Fork the repository from [kazupon/eslint-plugin-vue-i18n](https://github.com/kazupon/eslint-plugin-vue-i18n) !
45+
- Create your topic branch from `master`: `git branch my-new-topic origin/master`
46+
- Add codes and pass tests !
47+
- Commit your changes: `git commit -am 'Add some topic'`
48+
- Push to the branch: `git push origin my-new-topic`
49+
- Submit a pull request to `dev` branch of `kazupon/eslint-plugin-vue-i18n` repository !
50+
51+
## Development Setup
52+
53+
You will need [Node.js](http://nodejs.org) and [Yarn](https://yarnpkg.com/en/)
54+
55+
After cloning the repo, run:
56+
57+
$ yarn
58+
59+
### Commonly used scirpt with Yarn
60+
61+
# lint source codes and docs
62+
$ yarn lint
63+
$ yarn lint:docs
64+
65+
# run the vuepress
66+
$ yarn docs
67+
68+
# run the test suite
69+
$ yarn test
70+
71+
There are some other scripts available in the `scripts` section of the `package.json` file.
72+
73+
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.

0 commit comments

Comments
 (0)