Refactor `diff.ts` and `format.ts` Code into a Generic npm Package
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 5
- Avg merge
- 2h 58m
- Merged PRs (30d)
- 45
Description
Hi @int128,
First, thank you for your work on this repository.
I am writing to ask if you would consider refactoring the code, particularly the diff.ts and format.ts files, into a generic npm package, such as "git-diff-to-gha-md" or similar. This would allow the functionality to be reused in other GitHub Actions, such as one that writes to GITHUB_STEP_SUMMARY instead of pull request comments.
This enhancement would greatly benefit users who need similar functionality but in different contexts. I believe it would make your work even more versatile and widely adopted.
Thank you for considering this request. I look forward to your response.
Best regards
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading diff.ts and format.ts to understand the functionality proposed for extraction. Review how the current GitHub Action uses these files and determine the reusable package boundary and API. Done means the functionality is available as a generic npm package for use by other GitHub Actions, including contexts such as GITHUB_STEP_SUMMARY.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- ci-cd, developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100