feat: Add the result images in the README.

[Okabe-Junya]

Desired Feature

Add a captured image of an actual issue being created to the README. This will likely be very helpful for first-time users of this action and on the GitHub Marketplace.

Related

• [docs] Simple example in main README? #142 (comment)
• [docs] Simple example in main README? #142 (comment)

[Okabe-Junya]

We might have several things to consider:

• Which repo's created issue should we capture? (Probably this repo?)
• What should be the size of the capture?
• I use dark mode, but should we avoid using dark mode when capturing?

[spier]

I suggest to run the "getting started" workflow on this repo itself for e.g. the month of September 2023, and then take a screenshot of that. If that results in too many issues in the issue table, either cut that off in the screenshot a bit, or pick another month that has a smaller amount of issues/prs.

Also is the different in output for issues vs PRs significant enough to warrant a screenshot for each?
Or will one screenshot do?

[zkoppert]

I think one screenshot will do just to give folks an idea of the output. The action run on this repo would be good.

I'd aim for making the capture size around (doesn't have to be exact)

Height - 720 pixels
Width - 1280 pixels
Aspect ratio - 16:9
PPI - 72

source: https://tiny-img.com/blog/best-image-size-for-website/

I think getting a light mode image would be best (I use dark mode as well, but since the docs.github.com folks use light mode, probably best to match)

[spier]

Pasting some examples here for possible screenshots.

Note: Once we picked the screenshot that we want to uses, we should remove the tables below again.
They create all sorts of cross-references in the issues/prs automatically :)

SNIP: Removed samples, to prevent unintended cross-references in other GitHub issues (as the data contained links to GitHub issues and pull requests.

[Okabe-Junya]

Thank you for sharing some examples.

While these examples are great, capturing at 720 x 1280 might be a bit challenging. How should we go about capturing?

[Okabe-Junya]

If that results in too many issues in the issue table, either cut that off in the screenshot a bit, or pick another month that has a smaller amount of issues/prs.

You might be right, choosing a different month for the query might be better (for instance, the results from July or August might be better).

[spier]

I agree, 720x1280 will be hard for the tabular format that this GHA produces :)

I am already working on a PR. Almost ready. Let's review that together then and decide if we like it or not.

[Okabe-Junya]

Fantastic!

I'm looking forward to the PR. If needed, I can also help with the review. Just mention me when the time comes.