cheeaun/awesome-hacker-news

Add workflow to auto-sort list alphabetically

Open

#77 opened on Oct 2, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees) (134 forks)github user discovery
enhancementgood first issuehacktoberfest

Repository metrics

Stars
 (1,412 stars)
PR merge metrics
 (Avg merge 13h 15m) (1 merged PR in 30d)

Description

Currently there's a TOC generator workflow (.github/workflows/toc.yml) which is pretty neat. Having a workflow to auto-sort the list of links alphabetically would be nice.

Another solution would be a linter for PRs to make sure it's sorted, but I guess having this done automatically post-PR would be a better experience for both contributors and the maintainer (me).

Contributor guide

Research direction
Create a GitHub Actions workflow that runs on PR merge or push to main to sort the list of links alphabetically. Look at the existing TOC generator workflow (toc.yml) for reference.
Tech stack
github actions
Domain
ci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80