[RFC]: add link to each README to edit the file on GitHub - Githubissues

stdlib-js / www

Website for stdlib, a standard library for JavaScript and Node.js.

https://stdlib.io

Apache License 2.0

7 stars 8 forks source link

[RFC]: add link to each README to edit the file on GitHub #18

Closed kgryte closed 2 years ago

kgryte commented 2 years ago

Description

This RFC proposes adding a link to each README to edit the file on GitHub.

Currently, if a user finds a typo or bug in an example in a package README, there is no immediate way to directly edit that file.

Next to the link, we can place a ? icon (or something similar) which links to https://docs.github.com/en/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository, in case this is a user's first time contributing or interacting with a repository on GitHub.

Related Issues

No.

Questions

No.

Other

No.

Checklist

[X] I have read and understood the Code of Conduct.
[X] Searched for existing issues and pull requests.
[X] The issue name begins with RFC:.

kgryte commented 2 years ago

This is done.