dwyl / dwyl/github-backup

Epic: "Meta Data Table" in Issue Description

Open
#14 8 comments 2 reactions 2 assignees Assigned to @nelsonic View on GitHub
enhancement epic please-test priority-2 question
Dominant language
Elixir
Stars
33
Forks
3
PR merge metrics
No merged PRs in 30d

Description

As a `user` of the GitHub Backup App,
`I want` to see at a _glance_ if an issue has "version history"
`so that` I know there is "history" and I can click to see it!

## Acceptance Criteria

+ [x] **Meta Table** should be inserted into the **issue description** when the issue is Created.
+ [x] a comment advising people _not_ to delete/change it.
e.g: `` (_see below_)

+ [x] Minimise space occupied by the table to **Two Rows** to avoid clutter:
Heading (Key) & Row-Cell (Value) >> see below for example.

+ [x] Display the revision count for the issue.
We already have a "Proof of Concept" for using SVG as a Counter: http://hits.dwyl.io
e.g: [![HitCount](http://hits.dwyl.io/dwyl/github-backup.svg)](http://hits.dwyl.io/dwyl/github-backup)

+ [x] Display a "**short link**" (_dependent on the App / Domain Name chosen. see:_ #13)

## Optional (_Nice-to-Have_)
+ [ ] Subtle Color/Branding in the table.

## Question / Discussion:

What _other_ info would it be _useful_ to display in the "**Meta Table**"?
(_or should we "**keep** it **simple** for **MVP** and ask **users** once deployed_...?)

## Example:

Issue Edit Count | View History
:---------:|---------
9 | [gibu.io/**dwhq321**](https://github.com/dwyl/github-backup/issues/13)

> _**Note**: I would **prefer** to have a **single-line** table (for even less "clutter") e.g_:
```
+---------------------+-------------------------------+
| Issue Edit Count: 9 | View History: gibu.io/dwhq321 |
+---------------------+-------------------------------+
```
> _But **sadly** markdown does **not support** it_:
> https://stackoverflow.com/questions/17536216/create-table-without-header-in-markdown

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.