CodeDisc

A slack integration for discussing code present on GitHub repository.

Comment

Inspiration

Within my team and across the engineering organization, we are using GitHub for code collaboration.

It’s definitely not straightforward to discuss code available on GitHub. Thus, I thought to come up with a solution that makes code discussion for GitHub code easy and convenient using slack.

I have built a slack app that makes it easier for your teammates to discuss code available on GitHub during code reviews, testing, errors after merging/pushing code on GitHub directly from the slack.

What it does

It’s a simple GitHub + Slack integration for discussing code available on GitHub during code reviews, testing, errors after merging/pushing code on GitHub directly from the slack.
Also, it helps to find the keywords, crucial data, any other variables or anything present inside the GitHub file in lesser time. CodeDisc shares the code snippet with view on GitHub file link option directly on slack. It makes code reviews and discussion processes flexible. It also reduces the switches required by teams between slack & github.

How we built it

CodeDisc is built using Node JS, slack app and commands. There are following 4 commands inside the CodeDisc App:

  1. /codedisc [github file url] - Enter the GitHub file URL about whose content you want to have a discussion with your teammates. (required to be run first)

  2. /showlines [startlinenumber-endlinenumber] - It shows code snippet starting from startlinenumber upto the endlinenumber.

  3. /refer [github file url] [startlinenumber-endlinenumber] - Use it to find the specific code snippet inside the GitHub file. It shows code snippet starting from startlinenumber upto the endlinenumber of the [github file url].

  4. /find [keyword] - It finds the lines inside the GitHub file that contains the mentioned keyword.

My heroku URL link: https://glacial-meadow-75115.herokuapp.com/ Kindly, reach out to me if you face any issue/error while testing/running this app.

Challenges we ran into

Checking the app working, OAuth in Slack & publishing app in slack

Accomplishments that we're proud of

Developing the first slack app

What we learned

  • Integrating GitHub and Slack
  • Developing slack app

What's next for CodeDisc

Publishing it to slack. Making it available to a larger audience.

Built With

Share this project:

Updates