Contribution guide 🔮

An example project

STYLE GUIDE read before making a commit

Some interactive tutorials

Install node.js

To run a HTML page remotely (to share with other people) use rawgit and then paste in the link to your index.html. This will work as long as you aren't running any server-side code, so if you're using just client-side javascript you'll be fine! 😄

If you are using a computer where you do not have administrator access, login using your GitHub account on Cloud 9 IDE which will give you access to a virtual machine with node.js and a javascript editor in your browser. You can then make a new workspace directly from a github repository where you can run npm, standard, git, and all of your favourite GNU/Ubuntu commands including apt-get, ls, and cat etc.

To lint your code using Standard.JS and check that it conforms to the style guide you can use the "standard" node module. To install this globally run:

$ npm install -g standard

After that you can run the command standard in the root directory of the project and it will alert you to javascript formatting errors in any of the source files. You can automagically fix any errors by running.

$ standard --fix

Programming guide:

If you enter a new function into an existing project, add it to the exampleNS namespace e.g. if you want to add the clamp function to the exampleNS namespace write something like this:

var exampleNamespace = {};

(function (exampleNS) {
  ...
  exampleNS.clamp = function (x, min, max) {
    if (x <= min) {
      return min
    } else if (x > min && x < max) {
      return x
    } else if (x >= max) {
      return max
    }
  }
  ...
})(exampleNamespace)

You can then call this from inside the namespace like this:

...
(function (exampleNS) {
  ...
  exampleNS.somefunc = function () {
    var y = exampleNS.clamp(15, 10, 20)
  }
  ...
})(exampleNamespace)

and from other scripts like this:

var y = exampleNamespace.clamp(15, 10, 20)

If you want to declare a namespace-local "private" variable or function, then declare it as normal but within the namespace:

...
(function (exampleNS) {
  var namespaceLocal = 5
  ...
  exampleNS.addOne = function () {
    return namespaceLocal + 1
  }
  ...
})(exampleNamespace)

console.log(namespaceLocal === undefined); // true

Create objects as normal:

...
(function (exampleNS) {
  ...
  exampleNS.Vector3 = function (x, y, z) {
    this.x = x
    this.y = y
    this.z = z
  }

  exampleNS.Vector3.prototype.getLength = function () {
    return Math.sqrt(Math.pow(this.x, 2), Math.pow(this.y, 2), Math.pow(this.z, 2))
  }
  ...
})(exampleNamespace)

var vector = new exampleNamespace.Vector3(3, 4, 5)
console.log(vector.getLength()) // 7.07...