问题创建过程中的最终帮助。
ezissue-br的Python项目详细描述
EZ发行
在
##目录[目录]
它有什么作用?在
ezissue cli是一个具有命令行界面的应用程序,它的主要目标是帮助您 在项目的问题创建过程中。在
它将获取一个带有降价表的文件,并将其格式化并发送到您的repo的API。 因此,您将不再花费数小时手动创建问题。在
我为什么要用这个?在
如果您发现问题的创建过程是痛苦的,并且在开发某个东西时打破了您的full loko的情绪,那么这是为您准备的。在
但如果你想花几个小时在Github或Gitlab上创建问题并找到乐趣(我真心怀疑),我是谁来告诉你该怎么做!在
使用和配置
CLI接口
此程序有一个CLI,您可以利用它。正在运行ezissue --help
将显示CLI的用法和选项。在
$ ezissue --help Usage: ezissue [OPTIONS] FILENAME [github|gitlab] Options: --subid TEXT --numerate BOOLEAN --prefix [US|TS||BUG] --help Show this message and exit.
降价文件和配置
EZIssue程序采用.md
文件作为参数。该文件必须有一个markdown表才能解析问题。该表是一个常见的md表,可以有以下头:(注意,带有*
的头是必需的)
Header name | Description | Github support | Gitlab support |
---|---|---|---|
Title* | Issue’s title | Y | Y |
Description | Issue’s body or description | Y | Y |
Tasks | Will be a list of checkboxes. Items must be separated with commas. | Y (goes with description) | Y (goes with description) |
Acceptance criteria | Will be a list of checkboxes. Items must be separated with commas. | Y (goes with description) | Y (goes with description) |
Assignee | User that is assigned to the issue | Y (assignee’s username) | N (see next row) |
Assignees | List of users assigned to the issue | Y (array of assignee’s usernames) | Y (is a array of user ids) |
Labels | List of labels that are to be applied to the issue | Y (array of strings) | Y (single string, separated by commas) |
Confidential | Toggles the confidentiality of the issue | N | Y (boolean value) |
Milestone | Adds a milestone to the issue | Y (number of milestone) | Y (milestone id) |
Due | Sets a due date for stressing out your team | N | Y (datetime string in format ^{ |
Discussion | Links the issue to a discussion thread | N | Y (id of the discussion that it solves. Fills the description automatically) |
Weight | Sets the issue’s weight. Best used in XP | N | Y (integer with the issue’s weight, must be bigger than zero) |
示例:
问题输出格式如下:
^{pr2}$<!--title--> <PREFIX><SUBID><NUMBER> issue title <!--body--> **Issue description:** --- brief description **Acceptance criteria:** --- - [ ] condition a - [ ] condition b - [ ] condition c
更新当前版本
如果您的计算机中已经安装了我们的pip
版本,并希望更新到最新版本,请使用命令:
$ pip3 install --upgrade ezissue
想忏悔吗?这里有一些你可以快速处理的东西!在
我要事先感谢你的悔过。在这里您可以找到一些quick fixes,您可以查看。:)
- 项目
标签: