Skip to content

Do and Dont

Scott Sievert edited this page Feb 17, 2017 · 1 revision

Welcome to the NEXT-wiki wiki!

  • Don’t write to disk ever.
  • Don’t use custom stats and logs, use getModel
  • Do use Pep-8 (as much as reasonable)
  • Do use a real editor
  • Do ask lots of questions
  • Do write clean code
    • easy logic. Ideally code calls well-named functions less than 5 lines and has complete test coverage
    • easy to read (PEP8 -- follows Python naming conventions, <90 chars, etc)
  • Don’t have your code littered with comments and old code, GIT loves you
  • Do commit a lot
  • Do be careful about imports, only use them where necessary. You can import in functions.
  • Don’t reinvent the wheel. You never need to write a regexp parser unless you are Daniel Ross.
  • Don’t blame the verifier. It has the worst error messages but I guarantee you it’s your fault.

Clone this wiki locally