Programmers, communicate your intentions

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Yael Zaritsky Perez, Software Developer @ Wix
Software Developers, Communicate
Your Intentions!
(TL;DR: Do it Using Tests)...

About
me
00

Wix Engineering
Locations
Ukraine Israel Lithuania
VilniusKiev
Dnipro
Tel-Aviv
Be’er Sheva
Haifa

AGENDA
Communicate? Why?
Communicate? What?
Methods of Communication
Examples
Summary

Communicate?
Why?
01

Communicate
Why?
Robert C. Martin's quote about this

Communicate
Why?

New
FeaturesBugs
Communicate
Why?
We work on existing codebase

Don’t touch what
already works
Communicate
Why?
and need to feel comfortable to touch it
We work on existing codebase

Communicate
Why?
… also, we are not alone

Communicate?
What?
02

Communicate
What?
Libraries, APIs Inner Parts

Methods of
Communication
03

#1Documentation
Methods of
Communication
You don’t have to
change it
Usually outdated

Methods of
Communication
#2Verbal communication
We don’t remember
Not for everyone
No one stays forever

Methods of
Communication
#3Types
Add to the system
Can’t explain edge cases
Can’t tell a story

Methods of
Communication
#4Tests
Already there (?)
Live documentation

Using tests to communicate.
Examples
04

Example #1
Tests can tell a story

describe('Feed’, () => {
it('should render a single blog post’, () => {...})
it('should filter by ...’, () => {...})
})

How quickly can
you understand
this?
it('should render a single blog post', async () => {
nock(baseURL).get('/experts-blog...

it('should render a single blog post', async () => {
nock(baseURL)
.get('/experts-blog-posts')
.reply(200, [{ title: 'My e...

it('should render a single blog post', async () => {
nock(baseURL)
.get('/experts-blog-posts')
.reply(200, [{ title: 'My e...

it('should render a single blog post', async () => {
nock(baseURL)
.get('/experts-blog-posts')
.reply(200, [{ title: 'My e...

it('should render a single blog post', async () => {
nock(baseURL)
.get('/experts-blog-posts')
.reply(200, [{ title: 'My e...

Now,
Let’s Refactor it

it('should render a single blog post on feed', async () => {
nock(baseURL)
.get('/experts-blog-posts')
.reply(200, [{ titl...

Refactoring...
nock(baseURL)
.get('/experts-blog-posts')
.reply(200, [{ title: 'My epic blog post title', id: 13 }])
makeB...

Refactoring...
const { wrapper } = setup({})
const tab = queryByTestId(wrapper, 'feed-tab')
fireEvent.click(tab)
const { w...

Refactoring...
Part 3
expect(queryByTestId(wrapper, ‘blog-post-header-13’).textContent)
.toContain(‘My epic blog post titl...

it('should render a single blog post', async () => {
const wixBlogPost = createDisplayBlogPostWith({ id, title })
makeBlog...

it('should render a single blog post', async () => {
const wixBlogPost = createDisplayBlogPostWith({ id, title })
makeBlog...

Example #2
Breathing Documentation

const getImageUrlsFromImgNames = imageNameArr =>
imageNameArr
.map(imageName => nameToImageUrlMap[imageName])
.filter(imag...

describe('getImageUrlsFromImgNames', () => {
.
.
.
it('should filter out imageNames that don’t exist in map', () => {
imag...

Time to
Wrap
05

Using Tests as
Documentation
Worth our time
Live documentation
Tells the story
Explains edge cases
Prevents mistakes

Live documentation
Tells the story
Explains edge cases
Prevents mistakes
Using Tests as
Documentation
Worth our time
Saves...

“Any fool can write code that a computer
can understand. Good programmers write
code that humans can understand.“
-- Marti...

Thank You
yaelz@wix.com twitter@zaritskyPe_yael linkedin/yael-zaritsky-perez github.com/yaelz

Q&A
yaelz@wix.com twitter@zaritskyPe_yael linkedin/yael-zaritsky-perez github.com/yaelz

Sources
Clean Code (pdf)
Software Devs, communicate your intentions (Blog post)
yaelz@wix.com twitter@zaritskyPe_yael link...

Share SlideShare

Facebook
Twitter
LinkedIn

Embed

Size (px)

Show related SlideShares at end

WordPress Shortcode

Link

Share
Email

2024 State of Marketing Report – by... by Marius Sescu 13526 views
Everything You Need To Know About C... by Expeed Software 7118 views
Product Design Trends in 2024 | Tee... by Pixeldarts 3156 views
How Race, Age and Gender Shape Atti... by ThinkNow 2418 views
AI Trends in Creative Operations 20... by marketingartwork 32030 views
Skeleton Culture Code by Skeleton Technolo... 34419 views

Top clipped slide

1 of 43 Ad

1 of 43 Ad