From f682a43390af0901ac6bc502dadd411739cb05b3 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sun, 16 Aug 2015 17:37:54 +0200 Subject: Add documentation for click-contrib --- CHANGES | 1 + docs/contrib.rst | 25 +++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 27 insertions(+) create mode 100644 docs/contrib.rst diff --git a/CHANGES b/CHANGES index d3840a6..c96869c 100644 --- a/CHANGES +++ b/CHANGES @@ -24,6 +24,7 @@ Version 5.0 - Click will now warn if users are using ``unicode_literals``. - Click will now ignore the ``PAGER`` environment variable if it is empty or contains only whitespace. +- The `click-contrib` GitHub organization was created. Version 4.1 ----------- diff --git a/docs/contrib.rst b/docs/contrib.rst new file mode 100644 index 0000000..b9a2a01 --- /dev/null +++ b/docs/contrib.rst @@ -0,0 +1,25 @@ +.. _contrib: + +============= +click-contrib +============= + +As the userbase of Click grows, more and more major feature requests pop up in +Click's bugtracker. As reasonable as it may be for those features to be bundled +with Click instead of being a standalone project, many of those requested +features are either highly experimental or have unproven practical use, while +potentially being a burden to maintain. + +This is why click-contrib_ exists. The GitHub organization is a collection of +possibly experimental third-party packages whose featureset does not belong +into Click, but also a playground for major features that may be added to Click +in the future. It is also meant to coordinate and concentrate effort on writing +third-party extensions for Click, and to ease the effort of searching for such +extensions. In that sense it could be described as a low-maintenance +alternative to extension repositories of other frameworks. + +Please note that the quality and stability of those packages may be different +than what you expect from Click itself. While published under a common +organization, they are still projects separate from Click. + +.. _click-contrib: https://github.com/click-contrib/ diff --git a/docs/index.rst b/docs/index.rst index 602bd1d..5bfea5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,6 +93,7 @@ Miscellaneous Pages .. toctree:: :maxdepth: 2 + contrib changelog upgrading license -- cgit v1.2.1