CONTRIBUTING.md 1.1 KB
Newer Older
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
1 2 3 4 5 6 7 8
# Guidelines for Contributing

Thank you for your time on Wechaty.

# Link to Wechaty

Contribute by marketing: Add **Powered by Wechaty** Badge to your Project Homepage:

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
9
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/Chatie/wechaty)
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
10 11 12 13

## Markdown

```markdown
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
14
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/Chatie/wechaty)
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
15 16 17 18 19
```

## Html

```html
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
20
<a href="https://github.com/Chatie/wechaty" target="_blank">
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
  <img src="https://img.shields.io/badge/Powered%20By-Wechaty-green.svg" alt="Powered by Wechaty" border="0">
</a>
```

# Bug Report

Contribute by feedback, make code robust.

# Feature Request

Contribute by make product suggestion.

# Pull Request

Please:
 
1. submit issue to describe the problem to get start
Huan (李卓桓)'s avatar
doc  
Huan (李卓桓) 已提交
38 39 40 41 42 43 44
1. then send pull request as you need(with unit test & pass linting)
 
  ```bash
  $ npm run lint
  $ npm run test
  ```

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
45 46 47 48 49 50 51 52
1. and do not forget to reference the issue 

I built wechaty with pleasure because it can help others. help from you for wechaty will be very appreciated by the community.

Cheers!

Huan