You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
49 lines
761 B
49 lines
761 B
# Contributing
|
|
|
|
> If you are willing to contribute, first you should know that
|
|
> I will love you and so will the Telegram Bot community.
|
|
|
|
Before proceeding any further, read the following documents:
|
|
|
|
1. [code of conduct][coc]
|
|
1. [software license][license]
|
|
|
|
[coc]:https://github.com/yagop/node-telegram-bot-api/blob/master/CODE_OF_CONDUCT.md
|
|
[license]:https://github.com/yagop/node-telegram-bot-api/blob/master/LICENSE.md
|
|
|
|
|
|
### General Information
|
|
|
|
**Updating API Reference i.e. generating `doc/api.md`:**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
$ npm run gen-doc
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
**Running tests:**
|
|
|
|
Please read `test/README.md` for more information.
|
|
|
|
|
|
---
|
|
|
|
|
|
**Transpiling ES6 for older Node.js versions:**
|
|
|
|
We use babel to transpile the code:
|
|
|
|
```bash
|
|
$ npm run build
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
> E=mc²
|
|
|