Skip to content

Latest commit

 

History

History
executable file
·
113 lines (85 loc) · 6.04 KB

README.md

File metadata and controls

executable file
·
113 lines (85 loc) · 6.04 KB
Raw

EZIssue

Build Status

What does it do?

The ezissue cli is an application with command line interface which it's main objective is to help you in the issue creation process in your projects.

It takes a file with a markdown table with your issues, formats them and send them to your repo's API. Therefore you will no longer spend hours creating issues manually.

Why should I use this?

If you find that the issue creation process is painfull and it breaks your full-loko mood while developing something, this is for you.

But if you want to spend hours creating issues on Github or Gitlab and find it fun (I sincerely doubt it), who am I to tell you what to do!

Usage and configuration

CLI interface

This program has a CLI that you can take advantage of. Running ezissue --help will show you the usage and options for the CLI.

$ ezissue --help

  Usage: ezissue [OPTIONS] FILENAME [github|gitlab]

  Options:
    --subid TEXT
    --numerate BOOLEAN
    --prefix [US|TS||BUG]
    --help                 Show this message and exit.

Markdown file and configuration

The EZIssue program takes a .md file as argument. That file must have a markdown table for it to parse to issues. That table is a common md table and can have the following headers: (Note that headers with * are mandatory, and with ** are not yet implemented)

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 ( 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 YYYY-MM-DD)
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)

Examples:

The issue output format is the following:

 <!-- 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

Updating your current version

If you already have one of our pip releases installed in your machine and want to update to the latest version, use the command:

$ pip3 install --upgrade ezissue

Want to make a contribuition? Here are some quick stuff you can work on!

I want to thank you beforehand for your contribuition. Here you can find some quick fixes that you can look into. And be free to ask for new features, solve or add issues in our issue board. :)