mir/node-telegram-bot-api
2
0
Fork 0
mirror of https://github.com/yagop/node-telegram-bot-api synced 2025-08-22 09:57:10 +00:00
Code Issues Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Yago 2016-10-17 21:43:09 +02:00 committed by GitHub
parent 58566d2df5
commit 00d74d13c8
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,14 @@
If you are willing to contribute, first you should know I will love you and the Telegram Bot comunity too.
Other considerations:
- `README.md` is generated by the inline jsdoc with `npm run gen-doc`.
- Provide tests for your methods. For running tests you need to set some environment variables:
```bash
export TEST_TELEGRAM_TOKEN="123456:AAGoASDFJKnlj6uSQLIhjhBgOUY" # Your bot token
export TEST_USER_ID="66368736" # User wich the bot will send the messages (can be yours ID)
export TEST_GROUP_ID="-163889657" # A Telegram group which the bot have access
npm run test
```
- The code is transpilled with babel on Git Hook prepublish
- E=mc²