Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/platy/issues
Designing a format and tools for issue management within small open source projects
https://github.com/platy/issues
issue-board
Last synced: 20 days ago
JSON representation
Designing a format and tools for issue management within small open source projects
- Host: GitHub
- URL: https://github.com/platy/issues
- Owner: platy
- Created: 2015-07-04T23:54:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-01T17:04:08.000Z (almost 8 years ago)
- Last Synced: 2024-10-12T00:19:18.154Z (3 months ago)
- Topics: issue-board
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Issues
[issue board](http://emberexperiments.co/issues/issues.html)
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](RESEARCH.md)
- Early stages [SPEC.md](SPEC.md)
- The tasks for this project [issues/](issues)
- A node library to access an issues db on the fs [fsapi/](fsapi)
- An static issue board html generator using fsapi [issues-site-generator/](issues-site-generator)
- A generated issue board hosted on github pages [issue board](https://platy.github.io/issues/issues.html)