mattermost / mattermost/mattermost-plugin-github

Consider implementing subscriptions feature as a form/modal

Open
#780 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

1: UX Review
Dominant language
Go
Stars
179
Forks
180
Avg merge
1d 16h
Merged PRs (30d)
13

Description

Currently the subscriptions feature is all in the slash command `/github subscriptions add`, loaded with some unclear options through slash command flags, in particular the flag named `features`.

For example:

```
/github subscriptions add mattermost/mattermost-plugin-github --features pulls,issues,label:"Help Wanted"
```

![image](https://github.com/mattermost/mattermost-plugin-github/assets/6913320/456e0689-480d-4d38-8045-c2dbaa37aa74)

Description of the feature from the command's help text:

- `/github subscriptions add owner[/repo] [flags]` - Subscribe the current channel to receive notifications about opened pull requests and issues for an organization or repository
- `flags` currently supported:
- `--features` - a comma-delimited list of one or more of the following:
- `issues` - includes new and closed issues
- `pulls` - includes new and closed pull requests
- `pulls_merged` - includes merged pull requests only
- `pulls_created` - includes new pull requests only
- `pushes` - includes pushes
- `creates` - includes branch and tag creations
- `deletes` - includes branch and tag deletions
- `issue_comments` - includes new issue comments
- `issue_creations` - includes new issues only
- `pull_reviews` - includes pull request reviews
- `label:` - limit pull request and issue events to only this label. Must include `pulls` or `issues` in feature list when using a label.
- Defaults to `pulls,issues,creates,deletes`
* `--exclude-org-member` - events triggered by organization members will not be delivered (the GitHub organization config should be set, otherwise this flag has not effect)
* `--render-style` - notifications will be delivered in the specified style (for example, the body of a pull request will not be displayed). Supported values are `collapsed`, `skip-body` or `default` (same as omitting the flag).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the `/github subscriptions add` slash-command entry point and review how the `features`, `exclude-org-member`, and `render-style` options are currently handled. Define the form/modal scope and verify that it can configure the subscription choices and existing notification behavior described in the command help.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.