Yohan Dunon DYW972

JavaScript Coding Guidelines

This is a set of coding conventions and rules for use in JavaScript programming. It is inspired by the Sun document Code Conventions for the Java Programming Language. It is heavily modified of course because JavaScript is not Java.

The long-term value of software to an organization is in direct proportion to the quality of the codebase. Over its lifetime, a program will be handled by many pairs of hands and eyes. If a program is able to clearly communicate its structure and characteristics, it is less likely that it will break when modified in the never-too-distant future.

Code conventions can help in reducing the brittleness of programs.

All of our JavaScript code is sent directly to the public. It should always be of publication quality.

Git Best Practices

This is a fairly common question, and there isn't a One True Answer, but still, this represents a consensus from #git

Read about git

Knowing where to look is half the battle. I strongly urge everyone to read (and support) the Pro Git book. The other resources are highly

People

`:bowtie:`	😄 `:smile:`	😆 `:laughing:`
😊 `:blush:`	😃 `:smiley:`	☺️ `:relaxed:`
😏 `:smirk:`	😍 `:heart_eyes:`	😘 `:kissing_heart:`
😚 `:kissing_closed_eyes:`	😳 `:flushed:`	😌 `:relieved:`
😆 `:satisfied:`	😁 `:grin:`	😉 `:wink:`
😜 `:stuck_out_tongue_winking_eye:`	😝 `:stuck_out_tongue_closed_eyes:`	😀 `:grinning:`
😗 `:kissing:`	😙 `:kissing_smiling_eyes:`	😛 `:stuck_out_tongue:`

	# If you work with git, you've probably had that nagging sensation of not knowing what branch you are on. Worry no longer!

	export PS1="\\w:\$(git branch 2>/dev/null \| grep '^*' \| colrm 1 2)\$ "

	# This will change your prompt to display not only your working directory but also your current git branch, if you have one. Pretty nifty!

	# ~/code/web:beta_directory$ git checkout master
	# Switched to branch "master"
	# ~/code/web:master$ git checkout beta_directory
	# Switched to branch "beta_directory"

	# .zshrc
	# (copyleft) 2012 by Felix Ruess
	#


	# ---[ System settings ]------------------------------------------------
	limit -s coredumpsize 0
	umask 0027

	#!/bin/bash

	# -------------------------------------------------------
	# A shell script that generates a MIT LICENSE file
	# Written by: Tom Stewart
	# Last updated on: 2013/15/08
	# -------------------------------------------------------

	# Verify the type of input and number of values
	USAGE="USAGE: $0 copyright_year copyright_holders"

	#!/bin/sh

	# i3-get-window-criteria - Get criteria for use with i3 config commands

	# To use, run this script, then click on a window.
	# Output is in the format: [<name>=<value> <name>=<value> ...]

	# Known problem: when WM_NAME is used as fallback for the 'title="<string>"' criterion,
	# quotes in "<string>" are not escaped properly. This is a problem with the output of `xprop`,
	# reported upstream: https://bugs.freedesktop.org/show_bug.cgi?id=66807

	#!/bin/sh
	##3.5...10...15...20...25...30...35...40...45...50...55...60...65...70...75...80
	##
	## Debian / Linux / Ubuntu / LSB
	## Startup script for Express / Node.js application with the forever module
	##
	##
	## A modification of "init.d.lsb.ex" by Nicolas Thouvenin
	##
	##