all: add a few READMEs to help new people navigate the source tree #21034
Labels
Documentation
Issues describing a change to documentation.
NeedsFix
The path to resolution is known, but the work has not been done.
Milestone
Comments
josharian
added
Documentation
|
CL https://golang.org/cl/49291 mentions this issue. |
gopherbot
pushed a commit
to golang/blog
that referenced
this issue
Jul 17, 2017
Move the README to README.md so Gerrit can render it; currently Gerrit only renders files named exactly "README.md" (for example at https://go.googlesource.com/go). Add more links to the README explaining how to file issues, how to submit code changes, where to download the code to and how to get it. Hopefully this should help people who go to https://go.googlesource.com/blog or https://github.com/golang/blog figure out how to get started with development. Add a link in the footer to the source code for the blog, so people know where to find it. Updates golang/go#21038. Updates golang/go#21034. Change-Id: Ie378cf2aa42f56485b5d5c9a943f5b9957d96371 Reviewed-on: https://go-review.googlesource.com/49291 Reviewed-by: Russ Cox <rsc@golang.org>
|
CL https://golang.org/cl/50790 mentions this issue. |
|
CL https://golang.org/cl/50950 mentions this issue. |
gopherbot
pushed a commit
that referenced
this issue
Jul 26, 2017
Updates #21034 Change-Id: I951fb48ab3b9ed54d225c11879db8f09048a36a3 Reviewed-on: https://go-review.googlesource.com/50950 Reviewed-by: Rob Pike <r@golang.org>
ianlancetaylor
added
the
NeedsFix
gopherbot
pushed a commit
to golang/website
that referenced
this issue
May 26, 2021
Move the README to README.md so Gerrit can render it; currently Gerrit only renders files named exactly "README.md" (for example at https://go.googlesource.com/go). Add more links to the README explaining how to file issues, how to submit code changes, where to download the code to and how to get it. Hopefully this should help people who go to https://go.googlesource.com/blog or https://github.com/golang/blog figure out how to get started with development. Add a link in the footer to the source code for the blog, so people know where to find it. Updates golang/go#21038. Updates golang/go#21034. Change-Id: Ie378cf2aa42f56485b5d5c9a943f5b9957d96371 Reviewed-on: https://go-review.googlesource.com/49291 Reviewed-by: Russ Cox <rsc@golang.org> X-Blog-Commit: 63bb2e837512048b27c779e21e619dccbf6c027f
MK825
added a commit
to MK825/website
that referenced
this issue
Oct 18, 2022
Move the README to README.md so Gerrit can render it; currently Gerrit only renders files named exactly "README.md" (for example at https://go.googlesource.com/go). Add more links to the README explaining how to file issues, how to submit code changes, where to download the code to and how to get it. Hopefully this should help people who go to https://go.googlesource.com/blog or https://github.com/golang/blog figure out how to get started with development. Add a link in the footer to the source code for the blog, so people know where to find it. Updates golang/go#21038. Updates golang/go#21034. Change-Id: Ie378cf2aa42f56485b5d5c9a943f5b9957d96371 Reviewed-on: https://go-review.googlesource.com/49291 Reviewed-by: Russ Cox <rsc@golang.org> X-Blog-Commit: 63bb2e837512048b27c779e21e619dccbf6c027f
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The api directory has a friendly README file in it explaining what's in it. We should add short READMEs to some of the other top-level directories, particularly doc, lib, misc, and test.
The text was updated successfully, but these errors were encountered: