Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

all: add a few READMEs to help new people navigate the source tree #21034

Open
josharian opened this issue Jul 16, 2017 · 4 comments

Comments

@josharian
Copy link
Contributor

commented Jul 16, 2017

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.

@gopherbot

This comment has been minimized.

Copy link

commented Jul 17, 2017

CL https://golang.org/cl/49291 mentions this issue.

gopherbot pushed a commit to golang/blog that referenced this issue Jul 17, 2017
README, template: add more links
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>
@odeke-em

This comment has been minimized.

Copy link
Member

commented Jul 21, 2017

/cc @ucirello @smcquay and please feel free to tag others so we can get better navigation for everyone

@gopherbot

This comment has been minimized.

Copy link

commented Jul 23, 2017

CL https://golang.org/cl/50790 mentions this issue.

@gopherbot

This comment has been minimized.

Copy link

commented Jul 24, 2017

CL https://golang.org/cl/50950 mentions this issue.

gopherbot pushed a commit that referenced this issue Jul 26, 2017
test: add README
Updates #21034

Change-Id: I951fb48ab3b9ed54d225c11879db8f09048a36a3
Reviewed-on: https://go-review.googlesource.com/50950
Reviewed-by: Rob Pike <r@golang.org>

@ianlancetaylor ianlancetaylor added this to the Unplanned milestone Mar 30, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.