Versions Compared

Old Version 17

changes.mady.by.user Veena Basavaraj

Saved on

compared with

New Version 18

changes.mady.by.user Gwen Shapira

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

    •  Clear code is preferable to comments. When possible make your naming so good you don't need comments. When that isn't possible comments should be thought of as mandatory, write them to beread.
    •  Don't be sloppy. Don't check in commented out code: we use version control, it is still there in the history. Don't leave TODOs in the code or FIXMEs if you can help it. Don't leave println statements in the code. Hopefully this is all  obvious.  But if you still need to leave a TODO, create a ticket and then leave a TODO(SQOOP-1444), so we know what the details of the TODO are and who created it.
    •  Don't duplicate code (duh). Not even in tests. Not even constants!
    • Logging, configuration, and public APIs are our "UI". Make them pretty, consistent, and usable.

Sqoopesque Conventions !

Dont ask me which coding standard/ style guide prescribes the following conventions, but it exists in Sqoop predating 1.99.4 and the committers follow this religiously!. So spend you time wisely ! Feel free to leave comments on additional things you notice that might sound very much Sqoopesque ( Conventions that are less prevalent outside of Sqoop)  

...