问题创建过程中的最终帮助。

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 nameDescriptionGithub supportGitlab support
Title*Issue’s titleYY
DescriptionIssue’s body or descriptionYY
TasksWill be a list of checkboxes. Items must be separated with commas.Y (goes with description)Y (goes with description)
Acceptance criteriaWill be a list of checkboxes. Items must be separated with commas.Y (goes with description)Y (goes with description)
AssigneeUser that is assigned to the issueY (assignee’s username)N (see next row)
AssigneesList of users assigned to the issueY (array of assignee’s usernames)Y (is a array of user ids)
LabelsList of labels that are to be applied to the issueY (array of strings)Y (single string, separated by commas)
ConfidentialToggles the confidentiality of the issueNY (boolean value)
MilestoneAdds a milestone to the issueY (number of milestone)Y (milestone id)
DueSets a due date for stressing out your teamNY (datetime string in format ^{})
DiscussionLinks the issue to a discussion threadNY (id of the discussion that it solves. Fills the description automatically)
WeightSets the issue’s weight. Best used in XPNY (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你可以调查。:)

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何通过Intellij的查找功能替换整行代码?   java如何根据语言选择Url?   Java泛型方法无法调用约束更宽松的另一个泛型方法并返回其值   java操作JComboBox   java搜索两个字段匹配的记录   Java中的跳跃算法   用于在对象上添加/删除功能的java范例   java什么是com类文件的修复程序。谷歌。常见的基础找不到谓词?   这个算法的时间复杂度是多少   如何在forEach中执行操作并在Java流中将其传递给groupingBy   在java web应用程序中集成mahout推荐引擎时出现异常   java如何为Alfresco构建metawriter bean?   java循环的最长回文子序列   java如何配置Jitsimeet录制?   为什么java ToCharray语句有时才起作用?   java dependsOnGroups顺序orderTestng   java如何将对象转换为bean   安卓 studio中的java ArrayList<Event>结果大小为0