Improvements for issue link

Open
#43 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
react, typescript
Domain
frontend

Research direction

Start by inspecting the React component in this repository that renders GitHub issue permalinks and compare its current output with the attached example. The work is done when the rendered link is clearly identified as an issue and the initial issue text can be shown or expanded for a quick summary.

Written by the indexing model from the issue text.

Description

This is how issue link is currently showing in my blog:

image

It would be good if:

  1. It was clear that it's an issue.
  2. Perhaps the initial issue text can be shown and expanded, so the reader can get a quick brief of what the issue is about.
Dominant language
TypeScript
Stars
2
Forks
0
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dwjohnston/react-github-permalink

All issues in dwjohnston/react-github-permalink

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.