Skip to content

Commit

Permalink
Describe what this plugin creates
Browse files Browse the repository at this point in the history
  • Loading branch information
rlmartin committed Dec 7, 2022
1 parent c9f6068 commit 0eb60d1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# Skep: Slack plugin
A Slack implementation for [Skep](https://github.com/skeptools/skep-core).

## Features
This plugin will create the following for each team in the org:

1. A Slack user group for the team, so it can be called out in Slack with `@team-name`.
2. A Slack user group for each sub-team, e.g. `devs-only`, etc. Sub-teams are defined at the [org level](https://github.com/skeptools/skep-core/blob/main/src/organization.ts#L8) as a map of `sub-team-name` => `function that filters members of the team based on their Person properties`.
3. A private Slack channel for the team. The Slack user group is used to define membership in this channel. This can optionally be [turned off](./src/team.ts#L8). The standard prefix for the channel name is [defined at the org level](./src/organization.ts#L5).
4. A public Slack channel for the team. The Slack user group is used to define membership in this channel. This can optionally be [turned off](./src/team.ts#L9).

0 comments on commit 0eb60d1

Please sign in to comment.