Summary

Having proper tests and documentation helps your team work faster. By having automated tests, linting, and documentation, you help keep developers sane and make reviews easier.

Tests

  • Always write tests.
  • Prioritize writing tests in this order: unit, smoke, integration.
  • Set up linting for your CI.

Documentation

  • Write and maintain a README.md.
  • Make sure it has: requirements, setup instructions, external links.
  • Write inline documentation if you have time.

Done! Go back to the table of contents.

results matching ""

    No results matching ""