| 1 | # Contributing
|
| 2 |
|
| 3 | > If you are willing to contribute, first you should know that
|
| 4 | > I will love you and so will the Telegram Bot community.
|
| 5 |
|
| 6 | Before proceeding any further, read the following documents:
|
| 7 |
|
| 8 | 1. [Code of Conduct][coc]
|
| 9 | 1. [License][license]
|
| 10 |
|
| 11 | ## General Information
|
| 12 |
|
| 13 | ### Creating a Github issue:
|
| 14 |
|
| 15 | 1. Ensure that your issue does **not** already exist. [Do a search](https://github.com/yagop/node-telegram-bot-api/issues).
|
| 16 | 2. Browse through [StackOverflow](https://stackoverflow.com/search?q=telegram+nodejs) and other similar platforms.
|
| 17 | 3. Should you open your issue, ensure you use the English language for
|
| 18 | the wider target audience.
|
| 19 | 4. Be patient please.
|
| 20 |
|
| 21 |
|
| 22 | ### Updating API Reference i.e. generating `doc/api.md`
|
| 23 |
|
| 24 | Run:
|
| 25 |
|
| 26 | ```bash
|
| 27 | $ npm run doc
|
| 28 | ```
|
| 29 |
|
| 30 |
|
| 31 | ### Running tests
|
| 32 |
|
| 33 | Please read `test/README.md` for more information.
|
| 34 |
|
| 35 |
|
| 36 | ### Transpiling ES2015 for older Node.js versions
|
| 37 |
|
| 38 | We use babel to transpile the code:
|
| 39 |
|
| 40 | ```bash
|
| 41 | $ npm run build
|
| 42 | ```
|
| 43 |
|
| 44 | [coc]:https://github.com/yagop/node-telegram-bot-api/blob/master/CODE_OF_CONDUCT.md
|
| 45 | [license]:https://github.com/yagop/node-telegram-bot-api/blob/master/LICENSE.md
|