Goals

This document exists to outline the goals of this project.

The goals in general are the following:

1. Provide an interface to interact with Jira boards and issues from vim.
2. Make this interace simple and fast, in contrast to the Jira website.
3. A readable and easily modifiable source code.

All of the additions and contributions to this project should move towards one of these goals and at least not counteract any of the other ones. Now some clarifications:

Goal 1

The first goal is to provide an interface in Vim to perform basic interactions with Jira. Instead of having to go open a browser window and go through the pain of loading a million JavaScript files, you could see most of the information you need right here in vim. The interface should not deal with settings, administration, or any part except for boards and issues, deal with them well.

Goal 2

The second goal is to make a simple and fast interface for basic interactions performed through this plugin. The plugin must be efficient and not annoy the user with huge load times. The plugin must be simple and not have too much information, but just enough for a clean display and efficient processing of user commands. Too much information will clutter the screen and obscure useful information in a pile of text. Complicated plugins will add "bloat" to the software and make it harder to extend (see Goal 3) and decrease performance of the application in general.

Goal 3

The third goal is to make the source code easily modifiable. If the user wants more or less information, or information in places other than the one where it's currently displayed, or additional functionality (for example to integrate with his own platform), he should be free to do that. The user should be able to go into the source code and edit it however he wants easily without pouring a lot of time into figuring out how the code works.