DEV Community

Ben Halpern
Ben Halpern Subscriber

Posted on

What are the unwritten rules of development?

What underlying rules govern our work?

Which are good and which need to be dropped?

Top comments (71)

Collapse
 
ignoreintuition profile image
Brian Greig

When you are looking over someone else’s code, before you criticize, recognize that they likely did what they did for a reason.

Collapse
 
nektro profile image
Meghan (she/her) • Edited

You can't make a decision with information you don't have.

Collapse
 
bob_at_bh profile image
Bob Koon …amatata

100% this! When I do code reviews, I remember to always ask for clarification in a format like "what was the intent/your intention here?" instead of something like "why did you do it that way?"

As soon as one starts anything with "why", the receiver feels the need to be defensive. "Why" is an aggressive word and should be avoided.

Collapse
 
webreaper profile image
Mark Otway

Sorry, but "why" is not an aggressive word. Asking somebody why they did something is no more aggressive than asking what their intent was.

If "why" is coming across as aggressive in a code review, then it's because your overall code review experience is too adversarial, and needs to be reoriented to be more about achieving quality code, and less about blaming people for mistakes.

Collapse
 
devtlk profile image
Shaprieh

I love this! In the words of Erykah Badu "I'm and artist and I'm sensitive about my..." Coding is definitely an extension of creativity. Sound advice to keep defensive feelings out of it.

Collapse
 
rhymes profile image
rhymes

Great point! A corollary: don't judge the person by the quality of the code.

Collapse
 
raphael_jambalos profile image
Raphael Jambalos

That's true. People get better over time. And maybe the person who wrote that code is so much better now. I look down on the code I wrote 2 yrs ago, and that's just mark on the progress I made thus far.

Collapse
 
siwalikm profile image
Siwalik Mukherjee

Also an advise for code newbies, however stupid your code might look after reviews, never take review comments personally.

Your mentors have achieved a lot in their career and at some point, written crappy code too. So rather learn from their comments and be awesome. 🙌

Collapse
 
miku86 profile image
miku86 • Edited

I have an easy rule: Always start with a honest "Awesome, ...".
"Awesome, your code is very readable."
"Awesome, your layout is great."
"Awesome, your site looks great."
...

Collapse
 
nssimeonov profile image
Templar++

What if it's not?

Thread Thread
 
miku86 profile image
miku86

I think there's always one small thing.
"Awesome, you put some hard effort into it."

Thread Thread
 
nssimeonov profile image
Templar++

I appreciate your sarcasm :)

(in case it was not - read below)
I had two colleagues, who used to make me scream when seeing their code. First was so completely incompetent, that whatever he touched made significant regress, but he tried hard. Damn hard. He used to work for 10h/day and read tutorials for another few in his free time, but still 1 year and a half later he produced such unimaginable things, that I had to delete 80% of his code (and usually replace 10 lines with a single statement if at all).

The other one was competent, but sort of lazy and usually handed me code, where 60% of it was commented tests, some was incomplete and poorly tested. When asked to clean up his code he usually deleted the commented code... and a few lines of non-commented code inside them (yeah one can hardly spot them sometimes) and didn't even test before marking the task as complete.

Thread Thread
 
twigman08 profile image
Chad Smith

The first person is usually the type of person that I PERSONALLY will take time out of my day to sit next to and help out. Maybe code review the stuff together. I find that helps me fully get their thought process and I can explain my thought process more verbally and not just written. I personally have helped a few people that fit what you described (and I think more people who code review should do it).

The 2nd person should be brought up with to upper management in my mind. That's not fulfilling your job duties and his hurting the project and the company in the long run.

Collapse
 
thomasjunkos profile image
Thomas Junkツ

100% ACK. Additionally:

»the idea is not "why did you do this wrong" but "what made this seem like the right thing to do at the time to a reasonable and intelligent person in the situation?" -- Hard on systems. Soft on people.«

twitter.com/tottinge/status/105072...

Collapse
 
ben profile image
Ben Halpern

Damn that's a good rule.

Collapse
 
domitriusclark profile image
Domitrius • Edited

Learning how to ask the right questions (obviously) gets you the right answers BUT also helps you strengthen your understanding.

My mentor once told me 'A senior developer is just a developer that learned to ask the right questions by understanding the problem better'

Sticks with me everyday

Collapse
 
leahein profile image
Leah Einhorn • Edited

I love this! Do you have any suggestions on how to do that — how to ask the ‘right’ questions?

Collapse
 
domitriusclark profile image
Domitrius

I think the only answer to that is the cliche answer of time and building things. Once you build something unlike what you've built before, you'll find yourself tackling challenges that are new to you.

Your google-kwan-do will strengthen and you'll start to see others who have hit the same wall along with ways they accomplished it.

Collapse
 
selch profile image
selch

Don't release on Friday.

Collapse
 
dirtycode1337 profile image
Dirty-Co.de

That should be a point on every code-producing company's policy.

Collapse
 
moopet profile image
Ben Sinclair

There's only one, really, but I'm so bad at following it that I had to make it written

don't be a dick

Collapse
 
buinauskas profile image
Evaldas Buinauskas

Doesn't count anymore. It's written!

Collapse
 
spboyer profile image
Shayne Boyer

From a friend and mentor - "When you get to the top, send a ladder back down"

Collapse
 
guitarkat profile image
Kat

:) This makes me feel all the feels. I love it.

Collapse
 
jrohatiner profile image
Judith

Words to live by! Namaste!

Collapse
 
onejsninja profile image
Opesanya Adebayo

Sleep a little bit more. You'll squash your current bugs and have less of them to deal with in the next few days

Collapse
 
luqman10 profile image
Abdul Qadir Luqman

I can definitely relate with this one. Stepping away from your code (not necessarily sleeping), keeps you fresh and gives you a new angle of analyzing that stubborn bug.

Collapse
 
simonrice profile image
Simon Rice

I'd extend that to looking after yourself in general - getting enough to eat, drink, exercise and, as you rightly say, sleep! No code is worth losing your health & wellbeing over!

Collapse
 
rrampage profile image
Raunak Ramakrishnan

The fastest, safest and cleanest code is that which does not need to be written.

Collapse
 
jadjare profile image
jadjare

This is a rule I regularly promote.

Todo comments are not for bug fix reminders.
Todos are for acknowledging completed code could be done better but the current code meets requirements and is therefore shippable.

Collapse
 
elmuerte profile image
Michiel Hendriks

Yeah, we have // FIXME comments to remind us of bugs ;)

Collapse
 
rhymes profile image
rhymes • Edited

I am not saving lives.

Some developers write code with a lot of real life consequences, I'm not one of them. So I keep that in mind.

Collapse
 
edoxtator profile image
Doc

I had a boss who'd been in a Major in the Air Force, and had been wounded in combat. Whenever the debate over some technical point got very heated, he'd interject with, "Calm down. This isn't combat. Nobody is going to die if we pick the quick route over the safe route."

Collapse
 
rhymes profile image
rhymes

eheh great point :-)

Collapse
 
avjinder profile image
Avjinder • Edited

Exactly. I make mobile apps and crud apis and I still get so much anxiety over it. If I were writing code for airplanes, banks etc, I'd have anxiety 24/7. I'm still working on taking care of my anxiety but it's difficult.

Collapse
 
rhymes profile image
rhymes

take care of yourself Avjinder, that's the most important thing.

I don't have suggestions on how to combat anxiety but I remember this thread which talks about depression and anxiety. Maybe you can find some tips in there:

Thread Thread
 
avjinder profile image
Avjinder

Thank you for the link, it's really helpful. I am working on improving my mental health but the progress has been slow. I've chalked it up to this being my first professional job, and being handed a massive load of responsibility. I expect it to go away with time and experience, but only time will tell. One thing I've been recommended is to leave work at the workplace, and not bring it home with me. That has been helpful for me to a certain extent. Imposter syndrome is a bitch though, and cumbersome to get rid of.

Collapse
 
codingmindfully profile image
Daragh Byrne

You should read my article about programming and anxiety on DEV

Collapse
 
klabautercoder profile image
klabautercoder

Rule1: Write tests. Explain your processes in this tests.

Rule2: Write comments. Dont explain your code, explain why u wrote this code in this manner.

Rule3: Dont forget to do some research work before start coding. (Refresh your design pattern skills, architecture, dependencies around your projects, etc).

Collapse
 
romantolkachyov profile image
Roman Tolkachyov

The second assertion is controversial. The developer should not justify himself. He must share knowledge at first.