27
The Importance of Following The WordPress Coding Standards Tom McFarlin @tommcfarlin #wcatl

The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

  • Upload
    others

  • View
    3

  • Download
    0

Embed Size (px)

Citation preview

Page 1: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

The Importance of Following The WordPress Coding Standards

Tom McFarlin @tommcfarlin

#wcatl

Page 2: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Who is this guy?

Page 3: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

What We’ll Cover

The WordPress Coding Standards…

Page 4: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

What We’ll Cover

The WordPress Coding Standards…

1. Why They Are Important

Page 5: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

What We’ll Cover

The WordPress Coding Standards…

1. Why They Are Important

2. Why We Should Be Using Them

Page 6: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

What We’ll Cover

The WordPress Coding Standards…

1. Why They Are Important

2. Why We Should Be Using Them

3. The Dangers of Not Using Them

Page 7: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

What We’ll Cover

The WordPress Coding Standards…

1. Why They Are Important

2. Why We Should Be Using Them

3. The Dangers of Not Using Them

4. How They Contribute to Maintainability

Page 8: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Why Are They Important?

Page 9: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Why Are They Important?From Wikipedia…

Coding conventions are a set of guidelines for a specific programming language that recommend programming style, practices and methods for each aspect of a piece program written in this language. These conventions usually cover file organization, indentation, comments, declarations, statements,white space, naming conventions, programming practices, programming principles, programming rules of thumb, architectural best practices, etc.

Page 10: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Why Are They Important?

Coding standards provide guardrails for how we should organize our files and format our code.

Page 11: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Coding standards set an expectation of how code will be written.

Why Are They Important?

Page 12: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

We have other people in mind; other people have us in mind.

Why Are They Important?

Page 13: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Why Should We Use Them?

Page 14: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. To make it easy for other people (and us!)

2. To save time

Why Should We Use Them?

Page 15: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

When working on an open source project, you’re likely working with more people than you ever

have.

Why Should We Use Them?

Page 16: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Coding standards help us to read and write better code.

Why Should We Use Them?

Page 17: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Dangers of Ignoring Coding Standards

Page 18: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. It makes it difficult to diagnose a problem.

Dangers of Ignoring Coding Standards

Page 19: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. It makes it difficult to diagnose a problem.

2. We may write more complex code.

Dangers of Ignoring Coding Standards

Page 20: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. It makes it difficult to diagnose a problem.

2. We may write more complex code.

3. It can cost time and money

Dangers of Ignoring Coding Standards

Page 21: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

How They Contribute to Maintainability

Page 22: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. They prevent surprises.

How They Contribute to Maintainability

Page 23: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. They prevent surprises.

2. They can prolong an application’s lifetime.

How They Contribute to Maintainability

Page 24: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. They prevent surprises.

2. They can prolong an application’s lifetime.

3. It helps us get started faster.

How They Contribute to Maintainability

Page 25: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

1. They prevent surprises.

2. They can prolong an application’s lifetime.

3. It helps us get started faster.

4. …and more.

How They Contribute to Maintainability

Page 26: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Follow The WordPress Coding Standards.

Page 27: The Importance of Following The WordPress Coding Standards · 2015. 4. 17. · The WordPress Coding Standards Tom McFarlin @tommcfarlin ... practices and methods for each ... architectural

Follow The WordPress Coding Standards.

Please (and Thank You!)