From 80534a50b6bbd79c9955923b431b3ea816dff7f9 Mon Sep 17 00:00:00 2001 From: derAnfaenger Date: Thu, 2 Nov 2017 14:47:28 +0100 Subject: [PATCH] zulip_bots: Add directory for unmaintained bots. --- tools/run-mypy | 1 + .../zulip_bots/bots_unmaintained/README.md | 22 +++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 zulip_bots/zulip_bots/bots_unmaintained/README.md diff --git a/tools/run-mypy b/tools/run-mypy index 6982ee4..60e1f95 100755 --- a/tools/run-mypy +++ b/tools/run-mypy @@ -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.") diff --git a/zulip_bots/zulip_bots/bots_unmaintained/README.md b/zulip_bots/zulip_bots/bots_unmaintained/README.md new file mode 100644 index 0000000..9ec1345 --- /dev/null +++ b/zulip_bots/zulip_bots/bots_unmaintained/README.md @@ -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.