Conventions and preferences to be shared within teams to promote harmonious and joyful Ruby on Rails development.

teamshares.md

Teamshares

Conventions and preferences to be shared within teams to promote harmonious and joyful Ruby on Rails development.

1. we create 12factor apps

0. http://12factor.net/

2. we’re designing for humans

0. norman nielsen’s 10 usability heuristics for user interface design
1. shneiderman’s eight golden rules of interface design

3. we're also designing for developers

0. please add enough logging to give your application a voice, use the right Log Severity Level
1. tame crazy rails logging and also make it ready for log mining - use Lograge
2. how to write great commit messages https://chris.beams.io/posts/git-commit/#imperative

4. sprint 0

0. setup source control
1. setup git hooks
2. setup ci
3. setup boxen

5. test conventions

0. read betterspecs.org
1. use latest rspec conventions: expect(expectation).to eq()
2. write tests that check for negative scenarios before happy paths
3. use only one describe block per spec file
4. for contexts in model specs, use the name context ".method_name"
5. for contexts in controller specs, use the name context "http_verb /resource.:format"
6. sound direct, confident and explicit - f.ex. instead it "should return blah", write it "returns blah"

6. code conventions

0. all magic strings in translations yml
1. javascript has to be camel-case

7. git conventions

0. this captures it pretty well - https://github.com/alphagov/styleguides/blob/master/git.md

8. security, privacy and compliance

0. use uuids instead of ids
1. use .iso8601 timestamps

9. performance

0. process asynchronously all requests that can take longer than 2s, or are making another http request in the background

10. code nitpicks

10.1. for readability

0. don’t use quotes within strings - use %q() or %Q() instead
1. use if !(expr) instead of unless (expr), i know many people who suffer from unlessexia
2. prefer guard statements over if else, wherever possible
3. prefer case statements over conditionals built around value stored in a variable

11. preferred toolchain

11.1. gems

0. pagination: kaminari
1. authentication: devise
2. asynchronous processing: sidekiq
3. orm: mongoid
4. task scheduler: whenever

11.2. products & services

0. database server: postgres
1. document store: mongo
2. search engine: elastic search
3. ci-server: jenkins
4. monitoring: nagios
5. key-value-store: redis
6. ui framework: twitter bootstrap
7. ruby server: puma

12. human tendencies

0. we all are interruptable
1. if you're new to the team, and no one has yet told you what you're supposed to work on, firstly - 'relax !', then do anything you want related to the project. someone will come and speak to you about what is expected from you.
2. very often, you might be in a situation where you might want to work on something else that's going on which seems more interesting. no issues. make sure you sign-up accordingly in the next stand-up, try to pair on that story, or if you can't get it working your way, let your friendly tech-lead or PM know about it. we'll try and do something about it.

13. Good reads

0. Creating a gem