Issues

issue board

This project is an a attempt to specify an open and human readable distributed issue tracking database targeted at small open source projects.

Database Features:

• Can be stored within the project repository (either within the main project branch or in an orphan branch)
• Status can be verified with hooks - (eg. PR can only be merged if no task is in the state : 'in progress')
• Usable without any application - just text editor and file manager
• Usable offline
• Markdown issue bodies

Issue concepts stored in DB

• Task title
• Task body
• Task status
• Swim lanes
• Task assignee

Other things that we'll need in the db:

• Comments: probably have a format for appending them to the markdown body
• tags
• milestones

Tools we might want:

• Web interface for non-collaborators
• Text editor plugins for collaborators
• Notifications for assigned (/watched?) issues : maybe a git hook for the first version?
• Status page generators : maybe in jekyll
• Validator (only if some issue trees will not be valid)
• Changelog generator : probably add a grouping for release (maybe only in the end states) and then specify parts of the issue text that would appear in the generated changelog from it.

Directory structure example

Example:

project
├── ...
└── issues
    ├── open
    │   ├── Swimlane: Open task in a swimlane.md
    │   ├── Swimlane: Another open task in a swimlane.md
    │   ├── Open task on it's own.md
    │   └── ...
    ├── inprogress:platy
    │   └── The task I'm working on.md
    └── closed
        ├── Swimlane: Task I completed.md
        └   ...

Contents of this repository

• Research and motivation of the project RESEARCH.md
• Early stages SPEC.md
• The tasks for this project issues/
• A node library to access an issues db on the fs fsapi/
• An static issue board html generator using fsapi issues-site-generator/
• A generated issue board hosted on github pages issue board