25 May 2019

Web applications

History / Edit / PDF / EPUB / BIB / 1 min read (~61 words)
Software development Processes

  • 3 different environments: development, staging, production
  • Write migrations for schema changes
  • Use ORM if possible over raw queries
  • Always make it possible for testers to report the version they tested against
    • Simplest is to have a meta field in the head section

  • Mockups
  • SRS
  • Database and software architecture
  • Implementation
  • Test/QA
  • Deployment

  • Code changes are stored in git
  • Setup continuous integration
  • Have a testing framework
  • Use dependency management
  • Define a code standard
  • Prefer function/method typing over dynamic types
  • On every push to git
    • Code quality check
    • Code style check
    • Unit/functional/integration/system tests
      • Code coverage should be recorded during tests and a report made available
  • A project repository must have a README.md explaining how to run the project on your own computer
  • A project repository must have a RELEASING.md explaining how to release the code
  • Responsibilities are made explicit in terms of roles
  • Critical roles, such as project lead, must have a backup/shadow individual
  • Setup telemetry, alerts, profiling, logging
25 May 2019

Writing commits

History / Edit / PDF / EPUB / BIB / 1 min read (~85 words)
Software development Processes
  • One liner describing what changed (not period terminated)
  • A few lines describing in more details why things changed
  • GPG signed commit

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how

18 Aug 2017

Question answering

History / Edit / PDF / EPUB / BIB / 1 min read (~32 words)
General Processes
  • Have a question
  • Define the field that would best answer this question
  • Search online
  • Search for articles and books on the topic
  • Determine the likelihood that this field has already been researched
05 Aug 2017

Book reading

History / Edit / PDF / EPUB / BIB / 1 min read (~39 words)
General Processes
  • Read the table of contents
  • Rapidly skim through the various sections of the book
  • Determine what you want to get out of the book
  • Ask yourself questions about what you briefly read