Skip to content

Style Guide

Benjamin Nelson DeMann edited this page Nov 17, 2017 · 5 revisions

Style Guide

Here are some notes about how things work here

Spaces or Tabs?

I don't care what the python people say. Tabs make way more sense than spaces so we are using tabs instead of spaces.

Icons

All of our icons live in byu-pipeline-tools/assets/images/icons/tool-icons. They all can use the same icons so we might as well. The standard for the images is a 32x32 pixel svg. Svgs are great because they are vector images, they support transparency, and all of the software we use can support them. The blue color we are using is: The black we are using is: The icons are based heavily off of (and in most cases it just are) Font Awesome The typical work flow is:

  1. Get an svg of the icon I want from Font Awesome
  2. Assign blue fill and black background
  3. Size and center it correctly
  4. Put in the folder for the tools and for the website instructions.

Camel Case or Underscores or Dashes?

I am torn about this one. I think we just need to pick one and stick to it. But not dashes. That's no good for python or anything for that matter. Why was that even an option. For file names? I think we we should go with camel case.

Double Quotes or Single Quotes?

I like single quotes.

Global Variables

No. We should pass in variables into call backs using lambda functions