From 00d74d13c8d73fb60c781da383c90f45711d466c Mon Sep 17 00:00:00 2001 From: Yago Date: Mon, 17 Oct 2016 21:43:09 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5e2f50c --- /dev/null +++ b/CONTRIBUTING.md @@ -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²