Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 2.13 KB

todo.md

File metadata and controls

20 lines (15 loc) · 2.13 KB
Raw

ToDo

This is a list of todo's that should be implemented at some moment. As well a comprehensive list of missing features and known bugs

Features

  • Auto updater - When cfy command is run we check current CLI ver against most recent version on npm. If update is needed, we save it somewhere and on next run of CLI we offer the user the options to update to the latest version right after they run cfy. The reason I don't want to check ver on each run before anything else is to save time for the user. Would be cool to give the user an option to read change log diff between their and latest version.
  • Error handling - Currently none existent. Most errors will just exit the CLI or print a cryptic message.
  • Create Issue - Currently this action already exists on tickets, it just doesn't do anything. But if there's no issue available for a commit, then we should default to creating an issue, instead of continuing with no issue. This would require some sort of UI overhaul when selecting a ticket as well.
  • Communicating commit message structure better - When jira project is linked to a git folder. Should give a clear example of how the commits will look like, and if the user doesn't like it, we should give them an easy way to edit the template
  • Dry-run commit command - Just something that would output the commit message using the template to visually test if template is correct
  • Documentation - Currently written docs are pretty random. Some actual thought and examples should be put in. Maybe a gif or a video of the process
  • Quick action to open issue in browser after doing the commit or from cfy -t
  • Changelog generator
  • Add feature to create new branches based on tickets and later create pull requests with correct name and all

Bugs

  • When cfy is setting up config with project, there is a weird if statement, that has a bunch of else if, but no else and can fail silently. Requires some looking into
  • Currently there's no test done whether Jira auth info is accurate until trying to get tickets or projects. Should test the API immediately to know if something is wrong with provided auth