Skip to content

ci: add awesome-lint + CONTRIBUTING.md; conform README to Awesome format - #2

Merged
opensource-joe merged 1 commit into
mainfrom
claude/first-repo-pr-issues-3f97wc
Aug 9, 2026
Merged

ci: add awesome-lint + CONTRIBUTING.md; conform README to Awesome format#2
opensource-joe merged 1 commit into
mainfrom
claude/first-repo-pr-issues-3f97wc

Conversation

@opensource-joe

Copy link
Copy Markdown
Owner

What

Rounds out the repo's foundation with the official Awesome-list checks and a contributor guide.

  • awesome-lint in CI (.github/workflows/awesome-lint.yml): runs the official awesome-lint on PRs and pushes that touch the README. Pairs with the existing link checker.
  • CONTRIBUTING.md: entry format, guidelines, and how to run the checks locally (the README's Contributing section now links to it).
  • README conformance: brought the list into Awesome format so awesome-lint passes.

README changes (to satisfy awesome-lint)

  • Entry format: reformatted every entry to - [Name](url) - Description (Language). — the dash must follow the link directly, so the (language) tag moved to the end of the description. (CONTRIBUTING.md documents this format.)
  • License section removed: awesome-lint forbids an in-README license section; the LICENSE file remains the canonical source.
  • Links de-duplicated and the table of contents trimmed to content sections only.
  • Minor: "git" → "Git".

Testing

Both CI checks pass locally:

npx awesome-lint     # √ Linting

All 24 entries/links still resolve; entry content is unchanged apart from the format move.

🤖 Generated with Claude Code

https://claude.ai/code/session_01G4tz2TSgAci7hxTYSPm4xi


Generated by Claude Code

Adds the official awesome-lint check in CI and a CONTRIBUTING.md, and
brings the README into Awesome-format conformance:

- Reformat entries to `[Name](url) - Description (Language).` so the link
  is followed directly by the dash, as awesome-lint requires; the language
  tag moves to the end of the description.
- Remove the in-README License section (awesome-lint forbids it; the LICENSE
  file remains the canonical source) and de-duplicate links.
- Trim the table of contents to content sections only.

awesome-lint and the existing link checker both pass locally.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01G4tz2TSgAci7hxTYSPm4xi
@opensource-joe
opensource-joe merged commit 28d0cb9 into main Aug 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants