Skip to content

Commit 760b920

Browse files
committed
update to improve the suggestions for code review requests
1 parent abf7418 commit 760b920

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

manual/guides/katy/codereq.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ subtitle: "You have a bug. I am not your only hope."
55
permalink: /manual/guides/katy/codereq
66
---
77

8-
![Googling the Error Message](https://pbs.twimg.com/media/CfFPuvoWwAALmcC.jpg "The most important fake book of our time."){:width="270px"}
8+
![Googling the Error Message](https://raw.githubusercontent.com/denitdao/o-rly-collection/refs/heads/main/public/book_covers/google-error-message.jpg "The most important fake book of our time."){:width="270px"}
99
![Trying Stuff Until It Works](https://pbs.twimg.com/media/CfSQdwUW8AErog1.jpg:large "Another important fake book on persistence."){:width="270px"}
1010

11+
1112
# Google it
1213

1314
Please don't come to me with a question that can be solved by a Google search
14-
of the error. Especially if you are a Millenial from the U.S., Google really
15-
should be in your blood by now. For better google skills, consider
16-
[powering up your search tactics](http://www.powersearchingwithgoogle.com/course/aps/skills).
15+
of the error. In these modern times, Google really
16+
should be in your blood by now.
1717

18-
Once you google it, of course, try the things you found on google.
18+
Once you google it, of course, try the things you found on google, take notes,
19+
and read the errors for clues.
1920

2021
# Stack Overflow
2122

@@ -58,14 +59,29 @@ you will need to formulate a [Minimal Working
5859
Example.](http://stackoverflow.com/help/mcve)
5960

6061
Yes, sometimes a minimal working example is hard to create. If that's the case,
61-
I understand. However, you should still do what you can to document what you
62-
are trying to do, how you got where you are, how you tried to fix it. I will
63-
need this information to help you.
62+
I understand. However, simply the act of creating one is often enough to
63+
provide clues about the source of the error. As you proceed, please do what you
64+
can to document what you are trying to do, how you got where you are, how you
65+
tried to fix it. I will need this information to help you.
66+
67+
# Collaborate
68+
69+
You're probably in the office as you're doing your research, so you have an
70+
excellent resource very nearby! Your colleagues! You might just show them the
71+
error you're dealing with, or share your minimal working example on GitHub.
72+
Either way, try discussing it in person or on Slack with the other students,
73+
and maybe they can help.
6474

6575
# Contact me
6676

67-
If you have tried _everything_ above and nothing has been clarified, then
68-
should you email me. The email should include your minimal working example or
77+
There should be ample opportunities to ask me quick questions about what you
78+
can try to solve your bug -- try to drop by Coffee Chat or pop by my office if
79+
you think it'll only take a few minutes.
80+
81+
If you have tried _everything_ above and nothing has been clarified, and you
82+
think it might take a while to debut, then
83+
should you email me or Slack message me. If possible, it should point to details somewhere (ideally
84+
GitHub or a Gist) about your minimal working example or
6985
your detailed documentation of the problem (above). I may need a few days to
7086
look it over (so you may as well also add it to Stack Overflow in case they're
7187
faster than me.) If I can't help you fix it by email, I'll let you know we

0 commit comments

Comments
 (0)