This repository was archived by the owner on Jul 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbest-practices-programming.html
51 lines (51 loc) · 10.1 KB
/
best-practices-programming.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<!doctype html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><meta http-equiv="X-UA-Compatible" content="ie=edge"><meta name="description" content=""><!-- Bing --><meta name="msvalidate.01" content="45CBBE1BD8265A2217DFDA630EB8F84A" /><title>Tiny Brain Fans - Best Practices (Programming)</title><link rel="stylesheet" href="tinystyle.css"></head><body>
<main id="main"><article id="content"><h1 id="title">Best Practices (Programming)</h1><h2>Write code drunk, edit sober[5]</h2>
<p>When coding solutions to problems, overoptimization is your greatest enemy.</p>
<ol>
<li>Make it work, at all costs. Don't give two shits about it, because if it sucks, you can always delete it all anyway. Make liberal uses of <a href="git.html">git</a> commits to scaffold your way to a solution, but don't be afraid to just blow it up and start over.</li>
<li>When it works, refactor it. Make it understandable to a human being. Make it as concise as possible, but not too concise. Imagine you are seeing the code for the first time, does it make sense to you?</li>
<li>If necessary, make it fast. Unless you are doing some very crucial code where milliseconds matter, this optimization is not as crucial as you think it is.</li>
</ol>
<h2>Writing Code</h2>
<ul>
<li>Make readable code: readable code is the most important. It's easy to spoil clean code, but hard to get it back. In any time, improving readability is justice.[4]</li>
<li>It doesn't have to be fast. Of course it's better to be fast. But it is not important. This doesn't mean the code has to be super slow.[4]</li>
<li><strong>Programming isn't about the stack</strong> or the systems architecture; the arch meta will change faster than you can learn it.</li>
<li>The number of frontend Frameworks out there are N+1.</li>
<li><strong>DRY, recursive funcs, polymorphism are [typically] afterthoughts and should not be a goal while you're developing the solution.</strong></li>
<li>TAKE TIME OFF. <strong>If you have 24 hrs time off that's three days office time. TAKE. THEM. AND. GO. AFK</strong>. It's best to plan the time and let your team know. Try to make it non-work related (but not self-destructive): camping, reading, visit family, practice hobbies, volunteering with animal shelters, study fine art, date people .... Make memories. Please, just live your life.</li>
<li><strong>Understand what good testing means.</strong> If you have trouble with this, look at tests on github of frameworks/languages. The basic form of tests come in the following for Javascript for front/back end devs (Node.js specific?): Unit Tests, Integration Tests, End-to-end tests. <strong>Understand why they're utilized and how to leverage them for various use-cases.</strong></li>
<li><strong>Read the documentation. It's your job to understand what's going on internally</strong> for your stack's framework(s) and if it takes you a few days to estimate the work-cost of utilizing a new lib reading docs is time well spent. If management doesn't understand this time after time then look for a new place to work.</li>
<li>Buy you a whiteboard. <a href="problem-solving.html">Plan your work</a> on it - sprints, logic, component relationships, cat drawings. (and of course it doesn't have to be a whiteboard, but the open space of a whiteboard to track my weekly meetings, logic intuitions, etc. all are best expressed for me in a large space)</li>
<li><strong>Keep a journal</strong> if you can (or a blog/vlog/written notes if that's the way you track your thoughts). <strong>Reflecting on the way I thought about a problem or feature set has been the best way for me to recognize my growth.</strong> (e.g. In college we never really discussed the implications of "Immutability" though it was mentioned and I found that as I kept journaling my understandings of Immutability with the context of the problems at hand it helped to give me a portrait of how/when to utilize it for future projects more effectively.)</li>
<li>"Make it correct, make it clear, make it concise, make it fast. In that order." - Wes Dyer</li>
<li>"Programs must be written for people to read, and only incidentally for machines to execute." - Abelson & Sussman, Structure and Interpretation of Computer Programs</li>
</ul>
<h2>Job/Soft Skills</h2>
<ul>
<li><strong>The job of a programmer on a team is to communicate</strong>. You will not get a better application from all-nighters, you will not 'free solo' an application. All systems are the sum total of the discussions, joint planning, and hard work. Any product you concoct alone, devoid of communication, will fail in a team-based env. (though, shared all-nighters in a team session have been some of the best moments in my career, so take this one with a pinch of salt)</li>
<li>Few tho they are, <strong>programming "rock stars" exist</strong>: you will see them on NPM and may even work beside them or read their blog posts, but <strong>these are outliers</strong>. (Read "Outliers" by Malcom Gladwell for better context than I can provide). I had the opportunity of working with an "Outlier" and though my understanding of programing appreciated from that time, the codebase suffered (and still suffers) from it.</li>
<li>Kanban's will keep your team in check. <strong>Stay on top of your tracking especially if your portion is behind</strong>; it's not a mechanism of doubt or shame or illness or anything that contributed to you being behind on work. <strong>Your honesty is tantamount</strong>: when your peers start to doubt your abilities you're already in a bigger hole than you probably are. <strong>Learn to communicate the nature of your issues with the problem at hand</strong> and I guarantee that your peers will recognize it if not in whole than in part. Speak up!</li>
<li>Tell your boss to have patience. But first, learn how to tell your boss to have patience.</li>
<li><strong>Sprint estimations for new features are, in the practical sense, a fallacy</strong>. Feature-sprints are pretty loose unless you work with a team that's one-out-of-a-thousand. Pad your dates by a factor of 2 where you can. (2 months = 4 months, etc. - also depends on your team size.)</li>
<li><strong>If your team consistently underestimates the time needed</strong> for a patch/feature (sprints) after 1.5/1.75 yrs time <strong>consider leaving</strong> unless you (or management) can really commit to change in this regard.</li>
<li>"<a href="glue-work.html">Glue Work</a>." <strong>In the scope of dev, there are no enemies.</strong> Not your boss's boss, not your boss, not your team members, not your clients, not you. <strong>Company culture is usually your first culprit if things go wrong</strong>, and if you can't vocalize why/how then it requires one of two things: a contractor to debug your company culture OR for you to leave; there is (in my experience) no middle ground here. (Unless it's your job to fix it, at least learn how to recognize Glue Work: <a href="https://www.youtube.com/watch?v=KClAPipnKqw" target="_blank">https://www.youtube.com/watch?v=KClAPipnKqw</a>)</li>
<li>If you work for a non profit, make sure your worldview is in line with the org's mission statement and that those you work with harbor your own sentiments. If not, leave.</li>
<li><strong>Do not interview for new jobs with/on company property or during work hours.</strong> Even if you have consent to do so, just don't. Wait until lunch, wait until you're home to compose your email resp to an offer. Cover your bases legally especially in the realm of startups.</li>
<li>When looking for jobs, ask about their testing practices. If they don't really answer, obfuscate their response, or just dont have an answer, avoid them at all costs. <strong>Tests/testing are a symptom of a healthy company culture.</strong></li>
<li>Learn/Practice vocalizing thoughts such as "I think you're wrong, here's why..." and "I don't think that's right given ..." and "While that's part of the problem an equally (if not more) pressing issue is ..." It's important to <strong>learn how to vocalize your misgivings, even if you're not 100% confident about them</strong>; your intuitions about a given problem will usually find similar minds on the team chip-in and fill the gaps.</li>
<li>Empathy. Empathy for your co-workers, empathy for your clients, empathy for your past-self too. <strong>Practice empathy.</strong></li>
</ul>
<h2>Self Development</h2>
<ul>
<li>Make a habit of <strong>reading books if not directly related to dev then tangentially related</strong>. (4 books per year was a good pace for me.)</li>
</ul>
<h2>References</h2>
<ol>
<li><a href="https://www.reddit.com/r/webdev/comments/kzqmhb/im_in_awe_of_you_all/" target="_blank">https://www.reddit.com/r/webdev/comments/kzqmhb/im_in_awe_of_you_all/</a></li>
<li><a href="https://softwareengineering.stackexchange.com/questions/43151/should-you-sacrifice-code-readability-with-how-efficient-code-is" target="_blank">https://softwareengineering.stackexchange.com/questions/43151/should-you-sacrifice-code-readability-with-how-efficient-code-is</a></li>
<li><a href="https://www.infoq.com/articles/no-hotfix-deployment/" target="_blank">https://www.infoq.com/articles/no-hotfix-deployment/</a></li>
<li><a href="https://github.com/cotowali/cotowali/blob/main/docs/development.md" target="_blank">https://github.com/cotowali/cotowali/blob/main/docs/development.md</a></li>
<li><a href="https://www.bitquabit.com/post/learning-writing-and-coding-from-a-con-artist/" target="_blank">https://www.bitquabit.com/post/learning-writing-and-coding-from-a-con-artist/</a></li>
</ol>
<p class="last-modified">Last modified: 202206101419</p></article></main><footer><nav><a href="index.html">Sitemap</a></nav><div class="social"><p>Built using <a href="http://codeberg.org/milofultz/swiki" target="_blank" rel="noopener noreferrer">{{SWIKI}}</a></p><p><a href="http://codeberg.org/milofultz/" target="_blank" rel="noopener noreferrer">Codeberg</a></p><p><a href="http://milofultz.com/" target="_blank" rel="noopener noreferrer">milofultz.com</a></p><p><a href="https://merveilles.town/@milofultz" target="_blank" rel="me noopener noreferrer">Mastodon</a></p></div></footer></body></html>