aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
blob: 6cd409a1b23a27f7f3e530e562880f376d7a8d33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Contributing to cryptography
============================

As an open source project, cryptography welcomes contributions of many forms.

Examples of contributions include:

* Code patches
* Documentation improvements
* Bug reports and patch reviews

Extensive contribution guidelines are available in the repository at
``docs/development/index.rst``, or online at:

https://cryptography.io/en/latest/development/

Security issues
---------------

To report a security issue, please follow the special `security reporting
guidelines`_, do not report them in the public issue tracker.

.. _`security reporting guidelines`: https://cryptography.io/en/latest/security/
: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
sudo: false

language: python

cache:
    directories:
        - $HOME/.cache/pip

matrix:
    include:
        - python: 2.6 # these are just to make travis's UI a bit prettier
          env: TOXENV=py26
        - python: 2.7
          env: TOXENV=py27
        - python: 3.3
          env: TOXENV=py33
        - python: 3.4
          env: TOXENV=py34
        - python: pypy
          env: TOXENV=pypy
        - python: 2.6
          env: TOXENV=py26 OPENSSL=0.9.8
          addons:
              apt:
                  sources:
                      - lucid
                  packages:
                      - libssl-dev/lucid
        - python: 2.7
          env: TOXENV=py27 OPENSSL=0.9.8
          addons:
              apt:
                  sources:
                      - lucid
                  packages:
                      - libssl-dev/lucid
        - python: 3.3
          env: TOXENV=py33 OPENSSL=0.9.8
          addons:
              apt:
                  sources:
                      - lucid
                  packages:
                      - libssl-dev/lucid
        - python: 3.4
          env: TOXENV=py34 OPENSSL=0.9.8
          addons:
              apt:
                  sources:
                      - lucid
                  packages:
                      - libssl-dev/lucid
        - python: pypy
          env: TOXENV=pypy OPENSSL=0.9.8
          addons:
              apt:
                  sources:
                      - lucid
                  packages:
                      - libssl-dev/lucid
        - python: 2.7
          env: TOXENV=docs
          addons:
              apt:
                  packages:
                      - libenchant-dev
        - python: 2.7
          env: TOXENV=pep8
        - python: 3.3
          env: TOXENV=py3pep8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py26
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py27
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py33
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py34
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=pypy
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=pypy3
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py26 OPENSSL=0.9.8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py27 OPENSSL=0.9.8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py33 OPENSSL=0.9.8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=py34 OPENSSL=0.9.8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=pypy OPENSSL=0.9.8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=pypy3 OPENSSL=0.9.8
        - language: generic
          os: osx
          osx_image: beta-xcode6.3
          env: TOXENV=docs

install:
    - ./.travis/install.sh

script:
    - ./.travis/run.sh

after_success:
    - source ~/.venv/bin/activate && coveralls

notifications:
    irc:
        channels:
            - "irc.freenode.org#cryptography-dev"
        use_notice: true
        skip_join: true
    webhooks:
        - https://buildtimetrend.herokuapp.com/travis