xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

zulip_bots: Add directory for unmaintained bots.

Browse source
This commit is contained in:
derAnfaenger 2017-11-02 14:47:28 +01:00
parent cfb767ad0f
commit 80534a50b6
2 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
tools/run-mypy
View file

@ -24,6 +24,7 @@ exclude = [
# Excluded because we don't want to require bot authors to
# fully annotate their bots.
"zulip_bots/zulip_bots/bots",
"zulip_bots/zulip_bots/bots_unmaintained",
]
parser = argparse.ArgumentParser(description="Run mypy on files tracked by git.")

22
zulip_bots/zulip_bots/bots_unmaintained/README.md Normal file
View file

@ -0,0 +1,22 @@
# Unmaintained bots
This directory contains bots that are currently not maintained by the Zulip
community. They are untested and potentially buggy or completely nonfunctional.
We only know that they worked at the time of their creation.
We see potential in every bot included in this directory. Many were moved simply
because they didn't contain automated tests. Feel free to use or revive
these bots.
## Reviving a bot
To revive an unmaintained bot, go through our [Writing bots](
http://zulip.readthedocs.io/en/latest/writing-bots-guide.html) guide and check if
the bot meets the outlined criteria.
In particular, this means that the bot should:
* contain automated tests.
* be well-documented, with usage examples.
* provide a command set reasonably easy and convenient to use for a human.
Once a bot fulfills all the criteria, feel free to submit a pull request to add it
to the `bots` directory. We are happy to include it there.