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

doc: contribute.html is long and wordy #17802

Closed
bradfitz opened this issue Nov 4, 2016 · 13 comments
Closed

doc: contribute.html is long and wordy #17802

bradfitz opened this issue Nov 4, 2016 · 13 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@bradfitz
Copy link
Contributor

bradfitz commented Nov 4, 2016

Tracking bug for making the contribution process seem less intimidating, forked from #17794.

Observations:

  • contribute.html is long and wordy. It might be good for some users, but it scares other users.

Maybe we need a high-level summary at the top showing the brief steps, with links to more info, rather than making users read a book first.

Also, I had an idea to write a go-gettable tool to walk people through the contribution process step-by-step, inspecting their httpcookies (for Gerrit), CLA state, git config, git-codereview, etc, and telling them what to do next. I want the instructions for contributors to just be:

$ go get go4.org/tools/gocontribute
$ gocontribute

And then the tool would say what needs to be done next.

/cc @quentinmit @robmccoll

@josharian
Copy link
Contributor

Yes please. Anything we can do to make the barrier to entry lower will help a lot. We lose a lot of talented (and thus busy) potential contributors at step 1.

@mvdan
Copy link
Member

mvdan commented Nov 5, 2016

It's also longer than it could be because there are several "git aficionados" and "git terms" bits. Perhaps you should make a very short guide for newbies, ignoring all git internals, and a separate advanced information page for those who are already familiar with git-codereview and git gitself.

@quentinmit quentinmit added Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. labels Nov 7, 2016
@quentinmit quentinmit added this to the Go1.8Maybe milestone Nov 7, 2016
@bradfitz
Copy link
Contributor Author

No reason to tie this to Go 1.8. We can backport the docs later too, so it can go live on the website unrelated to the Go release cycle.

@gopherbot
Copy link
Contributor

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

gopherbot pushed a commit that referenced this issue Mar 16, 2017
Updates #17802

Change-Id: I65ea0f4cde973604c04051e7eb25d12e4facecd3
Reviewed-on: https://go-review.googlesource.com/36626
Reviewed-by: Ian Lance Taylor <[email protected]>
Reviewed-by: Chris Broadfoot <[email protected]>
gopherbot pushed a commit that referenced this issue Mar 16, 2017
…to a guide

Updates #17802

Change-Id: I65ea0f4cde973604c04051e7eb25d12e4facecd3
Reviewed-on: https://go-review.googlesource.com/36626
Reviewed-by: Ian Lance Taylor <[email protected]>
Reviewed-by: Chris Broadfoot <[email protected]>
Reviewed-on: https://go-review.googlesource.com/38312
@bradfitz bradfitz removed their assignment Apr 24, 2017
@gopherbot
Copy link
Contributor

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

gopherbot pushed a commit to golang/tools that referenced this issue Jun 7, 2017
Updates golang/go#17802

Change-Id: Ieb4be41039d414a3ba6766d98ed95a6154f964f4
Reviewed-on: https://go-review.googlesource.com/45078
Reviewed-by: Steve Francia <[email protected]>
@gopherbot
Copy link
Contributor

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

gopherbot pushed a commit to golang/tools that referenced this issue Jun 7, 2017
Updates golang/go#17802

Change-Id: I70d30c5ff12837d51d13b5ca7e73be96eb535286
Reviewed-on: https://go-review.googlesource.com/45079
Reviewed-by: Steve Francia <[email protected]>
@gopherbot
Copy link
Contributor

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

gopherbot pushed a commit to golang/tools that referenced this issue Jun 7, 2017
Updates golang/go#17802

Change-Id: Ic5278804203029926dd5a26e571f79aaafb13110
Reviewed-on: https://go-review.googlesource.com/45080
Reviewed-by: Steve Francia <[email protected]>
@gopherbot
Copy link
Contributor

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

gopherbot pushed a commit to golang/tools that referenced this issue Jun 7, 2017
…eckout

Updates golang/go#17802

Change-Id: I8eeae42f395dee4eedd17114f10bb56536783089
Reviewed-on: https://go-review.googlesource.com/45082
Reviewed-by: Steve Francia <[email protected]>
@gopherbot
Copy link
Contributor

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

gopherbot pushed a commit to golang/tools that referenced this issue Jun 7, 2017
Updates golang/go#17802

Change-Id: I2b5473bc0539a760c26889497a301808deb5e5ae
Reviewed-on: https://go-review.googlesource.com/45083
Reviewed-by: Steve Francia <[email protected]>
@gopherbot
Copy link
Contributor

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

@bradfitz bradfitz modified the milestones: Go1.10, Go1.9 Jun 13, 2017
@bradfitz
Copy link
Contributor Author

Bumping this to Go 1.10 for now. The recent reorganization helped.

The golang.org/x/tools/cmd/go-contrib-init tool is pretty nice now, but we could polish it up and recommend it during the Go 1.10 cycle.

@gopherbot
Copy link
Contributor

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

@bradfitz
Copy link
Contributor Author

Actually, we can drop the note in Go 1.9.

@bradfitz bradfitz modified the milestones: Go1.9, Go1.10 Jun 13, 2017
@golang golang locked and limited conversation to collaborators Jun 14, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

5 participants