faaezahmd

Git Branch Merging Best Practices

1. After you've selected a feature to work on, create a branch in your local repo to build it in.
   • $ git checkout -b calaway/short_description_of_feature
2. Implement the requested feature, make sure all tests are passing, and commit all changes in the new branch.
3. Checkout the master branch locally.
   • $ git checkout master
4. Pull down the master branch from GitHub to get the most up to date changes from others. If you practice git workflow as described here you should never have a merge conflict at this step.
   • $ git pull origin master
5. Make sure all tests are passing on master and then checkout your new branch.

• $ git checkout calaway/short_description_of_feature

faaezahmd

console.log("Before the first file is read.");
hypotheticalFileGetContents("sample.txt", function(fileContents){
	// fileContents now contains the file contents, this function is only called when the file read in the background has finished
	console.log("After the first file has completed reading.");
});

// You've now told it to start the first read, but it won't 'block' your script execution. It will do the read in the background, and immediately move on with the rest of your code.

console.log("Before the second file is read.");
hypotheticalFileGetContents("sample2.txt", function(fileContents){

faaezahmd

How to install virtualenv:

Install pip first

sudo apt-get install python3-pip

Then install virtualenv using pip3

sudo pip3 install virtualenv 

faaezahmd

Structuring a large jQuery application

This document assumes you are building a traditional backend-heavy application as opposed to a frontend-heavy appliction which would typically use a framework like Angular or React. The use of these frameworks make this document irrelevant, however also require a change to your application architecture and a much larger overhead in order to get content onto a page, so as a simple way to build interactive web content a simple jquery based js stack will do fine.

Directory structure

It's important you use a directory structure which is impartial to your development environment, chosen server language (Python v. Java v. C# ...), and styling framwork (Twitter Bootstrap etc). This layer of separation means you can swap out the styles or the backend with minimal changes to the Js, simple and maintainable.

Here's an example from the project root: