Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

Adding more emphasis to the need of create a go file before running ensure #1911

Merged
merged 1 commit into from
Jul 2, 2018
Merged

Conversation

fbidu
Copy link
Contributor

@fbidu fbidu commented Jun 27, 2018

What does this do / why do we need it?

Hello, first-time contributor here!

I was following along dep's tutorial right now and got stuck while trying to add new packages right before running dep init. It turns out I was missing creating a valid .go file beforehand.

After reading through some issues I found some references about the need to create a file before adding the first dependencies. When I went back to the documentation with more attention, I found the part I skipped.

I guess most users pay more attention to the highlighted code parts than to the overall text. I know it was my mistake but one that I think might happen to more users and can easily be prevented by changing the docs a little bit. I considered changing the paragraph structure but I think that a simple emphasis in bold text is enough

What should your reviewer look out for in this PR?

Do you need help or clarification on anything?

Which issue(s) does this PR fix?

@fbidu fbidu requested a review from sdboyer as a code owner June 27, 2018 02:34
@googlebot
Copy link
Collaborator

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

1 similar comment
@googlebot
Copy link
Collaborator

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

@fbidu
Copy link
Contributor Author

fbidu commented Jun 27, 2018

I signed it!

@googlebot
Copy link
Collaborator

CLAs look good, thanks!

1 similar comment
@googlebot
Copy link
Collaborator

CLAs look good, thanks!

Copy link
Member

@sdboyer sdboyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome, thank you for the contribution! 🎉 🎉

Yes, this is a rather important point, and it's definitely a gotcha that trips people. i've no qualms about bolding it 😄

@sdboyer sdboyer merged commit 494b5dc into golang:master Jul 2, 2018
@fbidu fbidu deleted the patch-1 branch July 3, 2018 17:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants