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

Add item on relative imports to FAQ #941

Merged
merged 5 commits into from
Aug 4, 2017

Conversation

JuFisch
Copy link
Contributor

@JuFisch JuFisch commented Aug 3, 2017

What does this do / why do we need it?

Adds a FAQ item "Does dep support relative imports?" to docs/FAQ.md. Created in response to #910.

What should your reviewer look out for in this PR?

Clarity of explanation and correct style - I tried to follow the FAQ's standard structure by pulling an explanation from existing issue discussion and quoting the author / linking to the page.

Do you need help or clarification on anything?

Happy to make changes to this if the content needs work!

Which issue(s) does this PR fix?

@JuFisch JuFisch requested a review from sdboyer as a code owner August 3, 2017 21:16
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.

yay, first PR! just one little nit.

docs/FAQ.md Outdated
> i. the toolchain already frowns heavily on them<br>
> ii. it's worse for our case, as we start venturing into [dot dot hell](http://doc.cat-v.org/plan_9/4th_edition/papers/lexnames) territory when trying to prove that the import does not escape the tree of the project -[@sdboyer in #899](https://github.com/golang/dep/issues/899#issuecomment-317904001)

For a refresher on Go's recommended workspace organization, see https://golang.org/doc/code.html. Organizing your code this way gives you a unique import path for every package.
Copy link
Member

Choose a reason for hiding this comment

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

nit: let's have some text, rather than just a naked link.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it! :) Will change 👍

@sdboyer
Copy link
Member

sdboyer commented Aug 4, 2017

LGTM - thanks! yay, first PR! 🎉

@sdboyer sdboyer merged commit c1aba4d into golang:master Aug 4, 2017
@JuFisch
Copy link
Contributor Author

JuFisch commented Aug 4, 2017

Yay, thanks @sdboyer!

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