Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.98 KB

CONTRIBUTING_STANDARDS.md

File metadata and controls

46 lines (28 loc) · 1.98 KB

Contents

Coding Standards and Best Practices

Coding Standards

Please use descriptive full word variable names.

  • In the lifecycle of most projects, fixing bugs and maintaining current features end up taking 50%+ of total engineering time.
  • Our goal is to create a code base that is easy to understand, making fixing bugs and maintaining current features as painless as possible. We will have many engineers working with this code, and we want to be welcoming to engineers who are new to the project.
  • Short variable names can often create confusion, where a new engineer needs to spend time figuring out what a short variable name actually means. (Ex/ “per” or “p” instead of “person”.) For this project please use descriptive full word variable names.
  • Fellow engineers should be able to zoom around the code and not get stopped with riddles created by short names.

If there's no issue, please create one

Let us Know you're working on the issue

If you're actively working on an issue, please comment in the issue thread stating that you're working on a fix, or (if you're an official contributor) assign it to yourself.

This way, others will know they shouldn't try to work on a fix at the same time.

We use SemVer for version numbers. More info: Versions: Release Names vs Version Numbers


Next: What the Heck is a Pull Request?

Go back to Readme Home