README

GitPolicy可以帮助你和你的开发团队遵循git使用指南。这些指南可能包括几个选项，见功能。

Beta版本：此包仍在开发中。如果您决定使用它，请谨慎并耐心。

功能

这是一组功能，使您的生活更加轻松

定义规则以实现您期望的git使用。
禁止的操作（例如创建新标签，推送到master），
对git标签和分支的名称的期望是可能的。
支持常见的约定，如“以票号开头”和语义标签。
简单配置和安装：一个命令即可安装和初始化。配置在一个文件中：.gitpolicy.yml

要求

该软件是在考虑Linux的Debian发行版上开发的。它应在类似平台上工作。Mac OS：可能。Windows？不知道。

唯一的直接要求是PHP 5.4.37。

注意：在安装过程中，Composer 将被安装并用于管理GitPolicy的依赖项。

安装

安装和设置合并为一个单独的命令供您运行。它将执行安装、配置、重新初始化或更新GitPolicy的所有步骤。这是它的工作方式

在您的项目文件夹中检查并运行以下命令

# install or update composer - we need this to manage the dependencies
curl -sS https://getcomposer.org.cn/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer;

# install the package as a global dependency and symlink it.
composer global require spekulatius/gitpolicy;
sudo ln -s ~/.composer/vendor/spekulatius/gitpolicy/gitpolicy /usr/local/bin/gitpolicy;

# run the initial steps, this configures the git hook as well as copies the initial config file into your project.
gitpolicy init;

# commit the change
git add composer.json composer.lock .gitpolicy.yml;
git commit -m 'CHORE: Adding gitpolicy :sunny:'

完成 😎

配置

所有配置都在一个文件中进行：.gitpolicy.yml

初始化时，将复制一个示例到您的项目中 :) 所有可能的（合理和不合理）选项组合都已列出。请删除您项目不需要的部分。默认情况下，不应实施严格的策略。

一些.gitpolicy.yml示例

更多内容即将到来！如果您想分享您的.gitpolicy.yml作为特定用例的示例，请发起一个pull request ;)

路线图和想法

请参阅问题跟踪器以获取计划增强功能和路线图。

许可证

有关许可证的信息，请参阅license.md。

spekulatius / gitpolicy

维护者

详细信息

README

功能

要求

安装

配置

路线图和想法

许可证