Skip to content

Commit

Permalink
Bump version and add plugin contribution guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
reillysiemens committed Jun 22, 2016
1 parent df4cf24 commit 803e38d
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@ to one of thse pages.
* Thursday & Friday: Random programming language
* Saturday & Sunday: Top HN story

## New Topics
Don't like the topics that `tb2k` currently supports? Follow the
[contribution guidelines] to add one!

## Resources
Slack API: [api.slack.com](https://api.slack.com/)

You should also check out [wb2k].

[wb2k]: https://www.github.com/reillysiemens/wb2k/
[virtualenv]: https://virtualenv.pypa.io/en/stable/
[contribution guidelines]: https://github.com/solus-impar/tb2k/blob/master/CONTRIBUTING.md
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

setup(
name='tb2k',
version='0.2.0',
version='0.3.0',
description='A python3 slack topic bot.',
author='Mike Canoy',
author_email='canoym@students.wwu.edu',
Expand Down

0 comments on commit 803e38d

Please sign in to comment.