E606 update readme/issue guidelines · sinabio/vue@873f6e2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 873f6e2

Browse files
yyx990803yyx990803
committed
update readme/issue guidelines
1 parent 4145c6a commit 873f6e2

File tree

2 files changed

+19
-39
lines changed

2 files changed

+19
-39
lines changed

‎CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ Hi! I’m really excited that you are interested in contributing to Vue.js. Befo
44

55
## Issue Reporting Checklist
66

7-
- Make sure that you are using the latest version of Vue.
7+
- The issue list of this repo is **exclusively** for bug reports and feature requests. For simple questions, please use either [Gitter](https://gitter.im/yyx990803/vue) or [vuejs/Discussion](https://github.com/vuejs/Discussion/issues).
88
- Try to search for your issue, it may have already been answered or even fixed in the development branch.
9-
- It is recommended that you make a JSFiddle to reproduce your issue. You could start with [this template](http://jsfiddle.net/5sH6A/) that already includes the latest version of Vue.
9+
- Check if the issue is reproducible with the latest stable version of Vue. If you are using a pre-release, please indicate the specific version you are using.
10+
- It is **reqruied** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will be closed immediately.
11+
- It is recommended that you make a JSFiddle to demonstrate your issue. You could start with [this template](http://jsfiddle.net/5sH6A/) that already includes the latest version of Vue.
1012
- 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.
1113

1214
## Pull Request Checklist

‎README.md

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,36 @@
22

33
# Vue.js [![Build Status](https://travis-ci.org/yyx990803/vue.svg?branch=master)](https://travis-ci.org/yyx990803/vue) [![Selenium Test Status](https://saucelabs.com/buildstatus/vuejs)](https://saucelabs.com/u/vuejs) [![Coverage Status](https://img.shields.io/coveralls/yyx990803/vue.svg)](https://coveralls.io/r/yyx990803/vue?branch=master)
44

5-
> MVVM made simple.
5+
## Intro
66

7-
## Introduction
7+
Vue.js is a library for building interactive web interfaces. It provides data-reactive components with a simple and flexible API. Core features include:
88

9-
Vue.js is a library for building interactive web interfaces. It provides the benefits of MVVM data binding and a composable component system with a simple and flexible API. You should try it out if you like:
9+
- Two-way data binding
10+
- Plain JavaScript objects as reactive models
11+
- Component-oriented development style
1012

11-
- Intuitive API that simply makes sense
12-
- Extendable Data bindings
13-
- Plain JavaScript objects as models
14-
- Building interface by composing reusable components
15-
- Flexibility to mix & match the view layer with other libraries
13+
Note that Vue.js only supports IE9 or above. To check out live examples and docs, visit [vuejs.org](http://vuejs.org).
1614

17-
It's really really easy to get started. Seriously, it's so easy:
15+
## Questions
1816

19-
``` html
20-
<div id="demo">
21-
{{message}}
22-
<input v-model="message">
23-
</div>
24-
```
17+
For questions and support please use the Gitter room: [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/yyx990803/vue) or submit issues at [vuejs/Discussion](https://github.com/vuejs/Discussion/issues). The issue list of this repo is **exclusively** for bug reports and feature requests.
2518

26-
``` js
27-
var demo = new Vue({
28-
el: '#demo',
29-
data: {
30-
message: 'Hello Vue.js!'
31-
}
32-
})
33-
```
19+
## Issues
3420

35-
To check out the live demo, guides and API reference, visit [vuejs.org](http://vuejs.org).
36-
37-
## Browser Support
38-
39-
Vue.js supports [most ECMAScript 5 compliant browsers](https://saucelabs.com/u/vuejs), essentially IE9+. IE8 and below are not supported.
21+
Please make sure to read the [Issue Reporting Checklist](https://github.com/yyx990803/vue/blob/master/CONTRIBUTING.md#issue-reporting-checklist) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
4022

4123
## Contribution
4224

43-
Read the [contributing guide](https://github.com/yyx990803/vue/blob/master/CONTRIBUTING.md).
44-
45-
## Get in Touch
46-
47-
- For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs)
48-
- Live discussion: [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/yyx990803/vue)
49-
- Bugs reports: first read the [issue checklist](https://github.com/yyx990803/vue/blob/master/CONTRIBUTING.md#issue-reporting-checklist), then [open an issue](https://github.com/yyx990803/vue/issues).
50-
- Questions, suggestions, feature requests: open an issue at [vuejs/Discussion](https://github.com/vuejs/Discussion/issues).
51-
- If you have a Vue-related project/component/tool, add it to [this list](https://github.com/yyx990803/vue/wiki/User-Contributed-Components-&-Tools)!
25+
Please make sure to read the [Contributing Guide](https://github.com/yyx990803/vue/blob/master/CONTRIBUTING.md) before making a pull request. If you have a Vue-related project/component/tool, add it to [this list](https://github.com/yyx990803/vue/wiki/User-Contributed-Components-&-Tools)!
5226

5327
## Changelog
5428

5529
Details changes for each release are documented in the [release notes](https://github.com/yyx990803/vue/releases).
5630

31+
## Stay In Touch
32+
33+
- For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs)
34+
5735
## License
5836

5937
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)
0