问题创建过程中的最终帮助。
ezissue的Python项目详细描述
ezissue
##目录[目录]
它是做什么的?
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
文件作为参数。该文件必须有一个标记表才能解析为问题。该表是一个通用的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) |
示例:
问题输出格式如下:
<!-- issue-table.md --> | title | description | acceptance criteria | | ----- | ----------- | ------------------- | | issue title | brief description | condition a;condition b;condition c |
<!--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你可以调查。:)