Automate updating of readme
andrew opened this issue · 6 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.
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.
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.
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.
Noted that this needs to be included as part of the functionality of #366.
@jessicaschilling this issue had actually been fixed for months, I would close but seems like a useful point for other work