Skip to content

Contribution Guidelines

hwano edited this page May 9, 2020 · 3 revisions

Contribution Guidelines

Developing

  1. Before you start, RTM if you're not ready
    Bolt
    SlackAPI

  2. install package

 $ git clone https://github.com/jho2301/42_Somoim.git
 $ cd 42_Somoim
 $ npm install
 $ npm install -g ts-node
  1. set environment varaibles(you can use dotenv)
  • SLACK_SIGNING_SECRET
    • Signing secret from the slack app you created in step 0.
  • SLACK_BOT_TOKEN
    • Bot token from the slack app you created in step 0.
  • COMMAND
    • you can specify slack command of your app
  • DB_DIALECT
    • setting database dialect ex)'postgres'
  • DB_USER
  • DB_PASSWORD
  • DB_NAME
  • DB_HOST
  • PORT
  1. run server
$ ts-node src/index.ts

Contributing

  1. If you have some problem with our Somoim slack app or have any ideas to get our app better, please use the issue tab of our repository.
  2. If you are going to do some contribution, please fork the reporsitory. When you made changes, please update documents about fixes.
  3. Once you have made all your tests, make a pull request to our repository.
Clone this wiki locally