awesome-ipfs icon indicating copy to clipboard operation
awesome-ipfs copied to clipboard

Automate updating of readme

Open andrew opened this issue 5 years ago • 5 comments

Currently every contribution requires checking out the repository locally, installing a bunch of npm modules and running the script to update the readme.

I propose we set up a github action that updates the readme after ever pull request has been merged, that way contributors only need to add the relevant yaml file and optionally add an image.

andrew avatar Feb 25 '20 16:02 andrew

It was also be good to get some kind of CI running against each PR as well to validate that their contributions will build correctly.

andrew avatar Feb 25 '20 16:02 andrew

I wonder why we need the readme in the repo in the first place. We could just explain how to modify the data of the repo in the readme and link to the website, and a text version of the website instead of adding the text-version again to the repo.

RubenKelevra avatar Feb 25 '20 16:02 RubenKelevra

This issue is one of the prioritized recommendations in the Q1 2020 IPFS Ecosystem Audit for execution in Q2/Q3 2020. Tagging it with $auditrecommendation means it's searchable! See all tagged issues in this repo.

jessicaschilling avatar Mar 20 '20 19:03 jessicaschilling

Noted that this needs to be included as part of the functionality of https://github.com/ipfs/awesome-ipfs/issues/366.

jessicaschilling avatar Nov 24 '20 19:11 jessicaschilling

@jessicaschilling this issue had actually been fixed for months, I would close but seems like a useful point for other work

andrew avatar Nov 24 '20 20:11 andrew

Closing this in an effort to reboot this list while keeping the maintainer overhead as low as possible while still making sure the list is awesome!

See https://github.com/ipfs/awesome-ipfs/pull/478 for more info

2color avatar Sep 21 '23 13:09 2color