kwalitee 0.2.0rc8

==========
Kwalitee
==========

.. image:: https://travis-ci.org/inveniosoftware/kwalitee.svg?branch=master
:target: https://travis-ci.org/inveniosoftware/kwalitee
.. 图像:: https://coveralls.io/repos/inveniosoftware/kwalitee/badge.svg?branch=master
:target: https://coveralls.io/r/inveniosoftware/kwalitee


安装
============

.. seealso:: :ref:`_installation`

Git 插件
=========
使用以下命令将 Git 插件安装到您的仓库中：

cd /path/to/git-repo
kwalitee githooks install

并使用以下命令卸载插件：

kwalitee githooks uninstall

以下插件将被安装

* ``pre-commit`` - 在提交文件时运行 PEP8、pyflakes 和版权年份检查。如果发现错误，则中止提交。
。
* ``prepare-commit-msg`` - 准备标准提交信息格式。
* ``post-commit`` - 检查提交信息格式和签名。如果发现错误，可以使用 ``git commit --amend`` 修复。
。

所有检查都可以使用以下命令禁用：

git commit --no-verify


Kwalitee 检查
===============

* 文件静态分析
* `pyflakes <https://launchpad.net/pyflakes>`_
* `PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_
* `PEP257 <http://legacy.python.org/dev/peps/pep-0257/>`_
* 许可证中的版权年份

* 提交信息分析
* 第一行少于 50 个字符，并符合模式 ``<component>: <short description>``（使用名词）。
。
* 正文包含对本次补丁所做更改的详细描述，格式为项目符号列表。（使用现在时态）。
。
* 必要签名：``Signed-off-by`` 和 ``Reviewed-by``。


许可证
=======
版权所有 (C) 2014, 2015 CERN。

kwalitee 是免费软件；您可以在自由软件基金会发布的 GNU 通用公共许可证的条款和条件下重新分发和/或修改它；许可证的第二版，或者（根据您的选择）任何较新版本。

kwalitee 的分发是希望它会有所帮助，但没有任何保证；甚至没有关于适销性或适用于特定目的的隐含保证。有关详细信息，请参阅 GNU 通用公共许可证。

您应该已经收到与 kwalitee 一起的 GNU 通用公共许可证副本；如果没有，请写信给自由软件基金会，Inc.，59 Temple Place，Suite 330，波士顿，MA 02111-1307，USA。

在适用此许可证时，CERN 不放弃因其作为政府间组织而享有的特权和豁免权，也不将自己置于任何司法管辖之下。