MIT-LCP/mimic-code

Newer

Older

Raw Normal view History

100644 30 lines (18 sloc) 1.02 KB

Mar 10, 2016 add template for styleguide
	1	# Style guide for the MIMIC Code Repository
	2
	3	## Overview
	4
	5	This guide provides some general guidelines on formatting code for the MIMIC Code Repository. Maintaining a consistent-ish style across the repository should make the code simpler to read and reuse.
	6
Mar 10, 2016 move header details to styleguide
	7	## Required header information
	8
	9	Please include the following header information at the top of your code:
	10
	11	```
Sep 15, 2016 removed version and author from individual files, better to track in …
	12	-- ------------------------------------------------------------------
	13	-- Title: Short descriptive title.
	14	-- Description: More detailed description explaining the purpose.
	15	-- ------------------------------------------------------------------
Mar 10, 2016 move header details to styleguide
	16	```
	17
Sep 15, 2016 removed version and author from individual files, better to track in …
	18	We would also recommend adding in any relevant references or usage notes in the top of the query.
	19
Mar 10, 2016 add template for styleguide
	20	## SQL
	21
Jun 14, 2016 Update styleguide.md
	22	- Always use uppercase for the reserved keywords like SELECT and WHERE.
	23	- Use lower case for other words such as table and column names.
	24
	25	For more detail, following the guidelines at: http://www.sqlstyle.guide/
Mar 10, 2016 add template for styleguide
	26
	27	## Python
	28
Sep 15, 2016 removed version and author from individual files, better to track in …
	29	Following PEP8 guidelines is recommended. Read more here: https://www.python.org/dev/peps/pep-0008/