edit | blame | history | raw

Contributing

All projects under the Pylons Projects, including this one, follow the guidelines established at How to Contribute, Coding Style and Standards, and Pylons Project Documentation Style Guide.

You can contribute to this project in several ways.

Git Branches

Git branches and their purpose and status at the time of this writing are listed below.

  • master - The branch on which further
    development takes place. The default branch on GitHub.
  • 1.9-branch - The branch
    classified as "stable" or "latest".
  • 1.8-branch - The oldest
    actively maintained and stable branch.

Older branches are not actively maintained. In general, two stable branches and
one or two development branches are actively maintained.

Developing

Follow the instructions in HACKING.txt to install Pyramid and the tools needed to run its tests and build its documentation.

edit | blame | history | raw
The majority of the code in Pyramid is supplied under this license:

  A copyright notice accompanies this license document that identifies
  the copyright holders.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:

  1.  Redistributions in source code must retain the accompanying
      copyright notice, this list of conditions, and the following
      disclaimer.

  2.  Redistributions in binary form must reproduce the accompanying
      copyright notice, this list of conditions, and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

  3.  Names of the copyright holders must not be used to endorse or
      promote products derived from this software without prior
      written permission from the copyright holders.

  4.  If any files are modified, you must cause the modified files to
      carry prominent notices stating that you changed the files and
      the date of any change.

  Disclaimer

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND
    ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
    TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
    TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
    THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    SUCH DAMAGE.

Portions of the code in Pyramid are supplied under the ZPL (headers
within individiual files indicate that these portions are licensed
under the ZPL):

  Zope Public License (ZPL) Version 2.1
  -------------------------------------

  A copyright notice accompanies this license document that
  identifies the copyright holders.

  This license has been certified as open source. It has also
  been designated as GPL compatible by the Free Software
  Foundation (FSF).

  Redistribution and use in source and binary forms, with or
  without modification, are permitted provided that the
  following conditions are met:

  1. Redistributions in source code must retain the
     accompanying copyright notice, this list of conditions,
     and the following disclaimer.

  2. Redistributions in binary form must reproduce the accompanying
     copyright notice, this list of conditions, and the
     following disclaimer in the documentation and/or other
     materials provided with the distribution.

  3. Names of the copyright holders must not be used to
     endorse or promote products derived from this software
     without prior written permission from the copyright
     holders.

  4. The right to distribute this software or to use it for
     any purpose does not give you the right to use
     Servicemarks (sm) or Trademarks (tm) of the copyright
     holders. Use of them is covered by separate agreement
     with the copyright holders.

  5. If any files are modified, you must cause the modified
     files to carry prominent notices stating that you changed
     the files and the date of any change.

  Disclaimer

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS''
    AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
    NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
    NO EVENT SHALL THE COPYRIGHT HOLDERS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGE.

The documentation portion of Pyramid (the rendered contents of the
"docs" directory of a software distribution or checkout) is supplied
under the Creative Commons Attribution-Noncommercial-Share Alike 3.0
United States License as described by
http://creativecommons.org/licenses/by-nc-sa/3.0/us/

Internationalization Code in ``pyramid.i18n`` is supplied under the
following license:

   Copyright (C) 2007 Edgewall Software
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in
       the documentation and/or other materials provided with the
       distribution.
    3. The name of the author may not be used to endorse or promote
       products derived from this software without specific prior
       written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
   OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
   IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
   IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Portions of the code marked as "stolen from Paste" are provided under the
following license:

    Copyright (c) 2006-2007 Ian Bicking and Contributors

    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.github/ISSUE_TEMPLATE/bug_report 748 b
.github/ISSUE_TEMPLATE/documentation 753 b
.github/ISSUE_TEMPLATE/feature_request 823 b
CONTRIBUTORS 8 KB
COPYRIGHT 265 b
HACKING 4 KB
LICENSE 7 KB
RELEASING 6 KB
TODO 5 KB
contributing 2 KB
docs/narr/myproject/CHANGES 28 b
docs/narr/myproject/README 485 b
docs/quick_tour/logging/CHANGES 28 b
docs/quick_tour/logging/README 491 b
docs/quick_tour/package/CHANGES 28 b
docs/quick_tour/package/README 491 b
docs/quick_tour/sessions/CHANGES 28 b
docs/quick_tour/sessions/README 491 b
docs/quick_tour/sqla_demo/CHANGES 28 b
docs/quick_tour/sqla_demo/README 852 b
docs/quick_tour/sqla_demo/sqla_demo/alembic/versions/README 32 b
docs/quick_tutorial/cookiecutters/CHANGES 28 b
docs/quick_tutorial/cookiecutters/README 488 b
docs/tutorials/wiki/NOTE-relocatable 492 b
docs/tutorials/wiki/src/authorization/CHANGES 28 b
docs/tutorials/wiki/src/authorization/README 478 b
docs/tutorials/wiki/src/basiclayout/CHANGES 28 b
docs/tutorials/wiki/src/basiclayout/README 478 b
docs/tutorials/wiki/src/installation/CHANGES 28 b
docs/tutorials/wiki/src/installation/README 478 b
docs/tutorials/wiki/src/models/CHANGES 28 b
docs/tutorials/wiki/src/models/README 478 b
docs/tutorials/wiki/src/tests/CHANGES 28 b
docs/tutorials/wiki/src/tests/README 478 b
docs/tutorials/wiki/src/views/CHANGES 28 b
docs/tutorials/wiki/src/views/README 478 b
docs/tutorials/wiki2/src/authentication/CHANGES 28 b
docs/tutorials/wiki2/src/authentication/README 844 b
docs/tutorials/wiki2/src/authentication/tutorial/alembic/versions/README 32 b
docs/tutorials/wiki2/src/authorization/CHANGES 28 b
docs/tutorials/wiki2/src/authorization/README 844 b
docs/tutorials/wiki2/src/authorization/tutorial/alembic/versions/README 32 b
docs/tutorials/wiki2/src/basiclayout/CHANGES 28 b
docs/tutorials/wiki2/src/basiclayout/README 844 b
docs/tutorials/wiki2/src/basiclayout/tutorial/alembic/versions/README 32 b
docs/tutorials/wiki2/src/installation/CHANGES 28 b
docs/tutorials/wiki2/src/installation/README 844 b
docs/tutorials/wiki2/src/installation/tutorial/alembic/versions/README 32 b
docs/tutorials/wiki2/src/models/CHANGES 28 b
docs/tutorials/wiki2/src/models/README 844 b
docs/tutorials/wiki2/src/models/tutorial/alembic/versions/README 32 b
docs/tutorials/wiki2/src/tests/CHANGES 28 b
docs/tutorials/wiki2/src/tests/README 844 b
docs/tutorials/wiki2/src/tests/tutorial/alembic/versions/README 32 b
docs/tutorials/wiki2/src/views/CHANGES 28 b
docs/tutorials/wiki2/src/views/README 844 b
docs/tutorials/wiki2/src/views/tutorial/alembic/versions/README 32 b
rtd 11 b
tests/fixtures/minimal 7 b
tests/fixtures/nonminimal 16 b
tests/test_config/files/assets/dummy 7 b
tests/test_config/files/minimal 26 b
tests/test_scripts/pystartup 138 b