Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Issue Tracking Notifications #8

Open
virajsazzala opened this issue Sep 27, 2023 · 4 comments
Open

feat: Issue Tracking Notifications #8

virajsazzala opened this issue Sep 27, 2023 · 4 comments
Labels
enhancement New feature or request hacktoberfest

Comments

@virajsazzala
Copy link
Member

Issue Tracking Notifications

Feature Summary

I propose enhancing the "gitscribe" bot's functionality to allow users to track specific GitHub issues and receive updates through direct messages (DMs) when changes occur. Currently, the bot provides information in the Discord channel where a command is issued, but it lacks a notification feature for individual issues.

Motivation

The motivation behind this feature request is to improve collaboration and keep users informed about GitHub issue updates. Users often have a keen interest in specific issues and would benefit from receiving notifications when changes, such as new assignees or comments, occur. This feature would enhance the bot's utility by providing timely notifications for tracked issues.

Use Case

Consider a scenario where a user wants to stay updated on a particular GitHub issue but doesn't want to manually check the issue page constantly. With this feature, they could use a command like !notify <ISSUE_LINK> to start tracking the issue. Whenever there are updates, the bot would automatically send the user a DM, keeping them informed without manual checks.

Current Behavior

Currently, the bot provides information about GitHub repositories and issues in the channel where the command is invoked, but it does not offer a notification feature for specific issues.

Proposed Behavior

This feature would enable users to subscribe to updates for a particular issue by issuing a command like !notify <ISSUE_LINK>. The bot would then monitor the specified issue on GitHub. When there are changes, such as new comments, assignee changes, or other updates, it would send a DM to the user who requested the notification.

Additional Information

Implementing this feature would enhance the "gitscribe" bot's usefulness by allowing users to stay informed about specific issues of interest without the need for constant manual checks. It could significantly improve community collaboration on GitHub projects.

Related Issues

None at the moment.

@virajsazzala virajsazzala added enhancement New feature or request hacktoberfest labels Sep 27, 2023
@virajsazzala virajsazzala changed the title [Feature Request] - Issue Tracking Notifications feat: Issue Tracking Notifications Oct 4, 2023
@lonewolf9277
Copy link
Contributor

Would the bot 'poll' for the issues every x minutes or should there be a way to 'notify' the bot via webhooks?

@virajsazzala
Copy link
Member Author

@lonewolf9277 Thanks for looking into this! I was trying to figure out a way to approach this too.

About your query:

  • If the bot tries to 'poll' for issues every x minutes, It won't be like an instant notification. That would defeat the purpose, as we need instant notification of sorts.

  • About the webhooks part, I've looked into it a little bit and for now, I feel like that's a good approach. As, It would give instant notification of sorts, which is what we are trying to achieve.

Could you look more into this, and drop some more information, about how it can be implemented with webhooks, etc..

@lonewolf9277
Copy link
Contributor

Sure I'll look into it.

@lonewolf9277
Copy link
Contributor

It seems the user needs to have access to the repo for webhooks to work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants