Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.98 KB

Where to start?

This document describes everything to do with contributing to this repository, including commit style, coding style, submitting issues, and making pull requests.

If you want to contribute and don't know where to start, we are a bunch of incredibly friendly people who are very eager to help you out! A good place to go is to look at our issues list for anything tagged with the good first issue label.

Issues

Try to stick to the template where possible!

Pull Requests

If the pull request should resolve any issues, please list them in a comment!

Furthermore, if you are making any frontend changes, please include some screenshots of them!

Commits

The subject line should be in the imperative and be less than 50 characters in length.

(If this helps, imagine saying the sentence "This commit will SUBJECT_LINE". eg. "This commit will Add the ability to create ice cream")

Do not end the subject line with a period.

Leave a gap between the subject line and the body.

Wrap the body at 72 characters.

For more info on committing, please read this.

Coding Standards

Tabs or Spaces?

Indentations are done with 2 spaces, for all languages and file formats:

public struct AttributeKey<Value> {
  let keyName: String
  let applyFunc: (Value) -> AttributeValue

  internal init(_ key: String, apply: @escaping (Value) -> AttributeValue) {
    self.keyName = key
    self.applyFunc = apply
  }
}

Our Stylesheets and Their BEM

CSS is great but it's easy to end up with hundreds of classes that overlap, underlap and wrestle with each other and that's when things get a whole lot less fun. To keep our stylesheets from this fate, we adopt Airbnb's naming convention for CSS. You can read about that here.