-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump version and add plugin contribution guidelines.
- Loading branch information
1 parent
df4cf24
commit 803e38d
Showing
3 changed files
with
28 additions
and
1 deletion.
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,21 @@ | ||
# Contributing to `tb2k` | ||
|
||
`tb2k` keeps plugins in the [`topics.functions`][topic functions] module. If | ||
you'd like to contribute a topic source of your own you can submit a pull | ||
request to this repository adding a function to that module. Topic functions | ||
**MUST** conform to the following specification: | ||
|
||
1. Begin with the `topic_` prefix. | ||
2. Take no arguments. | ||
3. Return a `topic` string and a `link` string as a tuple. | ||
- The `link` _can_ be the empty string. | ||
|
||
An example topic function might look like this: | ||
```python | ||
def topic_wwucs(): | ||
topic = 'WWU CS rules!' | ||
link = 'https://wwucs.slack.com' | ||
return topic, link | ||
``` | ||
|
||
[topic functions]: https://github.com/solus-impar/tb2k/blob/master/topics/functions.py |
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
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