-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37 from ise8933/main
Contribution for Slack Bot
- Loading branch information
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| layout: post | ||
| # If your post title is longer or more complicated | ||
| # than can be represented in the filename, uncomment the following line | ||
| # and specify a custom title | ||
| # title: "CHAOSS Slack Bot Contribution" | ||
|
|
||
| # Uncomment only one of the below categories | ||
| categories: | ||
| #- Bug Fix | ||
| - Contribution | ||
|
|
||
|
|
||
| # Enter your name below | ||
| author: Isha Errande | ||
| --- | ||
|
|
||
| For my contribution, I chose to contribute to the CHAOSS slack bot. The slack bot is built using bolt for javascript. The current main goal for this particular project is to make it easier for beginners to contribute. | ||
| I mainly did fixes to the main SETUP.md file and contributed ideas for the wiki. | ||
|
|
||
| ## Introduction to Issue | ||
| Back when I was trying to make a contribution for my bug fix, I contacted CHAOSS both on slack and through their github to attempt to find an issue. I originally commented under issue [number 98](https://github.com/chaoss/chaoss-slack-bot/issues/98). I got a reply after after I completed my bug fix for a seperate project. | ||
|
|
||
|  | ||
|
|
||
| The new issue consisted of adding a missing step within the setup doc. This is [issue 101](https://github.com/chaoss/chaoss-slack-bot/issues/101) | ||
|  | ||
|
|
||
|
|
||
| ## Solving the Issue | ||
|
|
||
| While trying to fix the issue, one of the main contributors closed the issue. I immediately double checked if the issue was fixed, and immediately messaged the main contributor to reopen the issue. | ||
|
|
||
|  | ||
|
|
||
| After resolving this small hurdle, I was officially assigned the issue and started to go down the set up steps to see if anything was missing. While adding the step was an easy fix, I did end up finding other small issues | ||
| with the doc. For example, some of the scopes were in the wrong categories or missing in the wiki, leading to some confusion setting up the basic configurations. There were also a lack of images under some sections, and adding images would make it easier for a beginner to follow the instructions better. | ||
| The correct option to choose would be to choose "From Scatch" instead of "app Manifest". App manifest is for setting up scopes using a file that contains configurations for the user and bot scopes, name, etc for the bot app. In this case, the setup doc manually sets up the scopes, events, etc using Slack's existing UI. In the future, CHAOSS slack bot could have a new issue to make an app manifest which would save a considerable amount of time in the future. For now though, I added in the extra step below. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| In addition to this I also added extra images under the set up events section of SETUP.md | ||
|  | ||
|
|
||
|
|
||
| After finishing up this issue, I proceeded to add another section under the wiki for user scopes. There were tables for bot scopes and events, but having a table for user scopes would also help. I went back to issue [number 98](https://github.com/chaoss/chaoss-slack-bot/issues/98) and attempted to clone and contribute using the directions given. It failed to work for me, so I tagged the two contributors working on the section to add the table I made for the wiki section. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Resolution | ||
|
|
||
| In the end, the main issue I contributed to was accepted along with my corrections ! This was the first contribution I did which was accepted so it was a big accomplishment. I am still waiting for a reply for my wiki contribution. | ||
|  | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|