Skip to content

Commit b90670c

Browse files
authored
Create CONTRIBUTING.md
1 parent 2e8cec2 commit b90670c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing guidelines
2+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
3+
4+
## Proposing a change
5+
If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. This lets us reach an agreement on your proposal before you put significant effort into it.
6+
7+
## Javascript style guides
8+
JavaScript must adhere to [Vue.Js official recommended style](https://github.com/vuejs/eslint-plugin-vue).
9+
10+
## DocBlock
11+
Every function, methods, computed properties, props should have a docblock to explain what it does
12+
13+
example:
14+
```js
15+
/**
16+
* Check provided value againts maximum allowed.
17+
* @param {Number} value
18+
* @return {Boolean}
19+
*/
20+
checkMaxValue (value) {
21+
if (this.max) {
22+
if (value <= this.maxValue) return false
23+
return true
24+
}
25+
return false
26+
},
27+
```
28+
29+
## Test
30+
- Make sure current tests is all green :white_check_mark:
31+
- If you've added code that should be tested, add tests!
32+
- Any new feature or changes should include tests for it.
33+
34+
## Readme
35+
Update the [README.md](https://github.com/kevinongko/vue-numeric/blob/master/README.md) with details of changes.

0 commit comments

Comments
 (0)