Skip to content

Commit

Permalink
updated contributing.md to refer to idiomatic js guide
Browse files Browse the repository at this point in the history
  • Loading branch information
walterhiggins committed Jan 30, 2014
1 parent 621245a commit e52b665
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ This project uses a Maven-like directory structure...
scriptcraft +
ScriptCraftPlugin.java

javascript +
lib +
(core javascript code goes here. Modules in this directory
should not be 'require'd by plugin or module authors)
modules +
(this is where module authors should put modules for
use by others)
plugins +
(this is where plugins - scriptcraft extensions for use by
operators and players should go)
js +
lib +
(core javascript code goes here. Modules in this directory
should not be 'require'd by plugin or module authors)
modules +
(this is where module authors should put modules for
use by others)
plugins +
(this is where plugins - scriptcraft extensions for use by
operators and players should go)
resources +
plugin.yml
docs +
Expand Down Expand Up @@ -71,6 +71,14 @@ called `greet.js` located in the plugins folder...
global. Anyone with operator privileges can type `/js greet(self)` at
the in-game command prompt to execute the function.

## Coding Conventions

See <https://github.com/rwaldron/idiomatic.js> for a recommended
approach to writing javascript code for ScriptCraft. ScriptCraft is
aimed at younger programmers so readability is important - moreso than
cleverness. If submitting new code for inclusion in ScriptCraft please
ensure it is documented using the guidelines below...

## Documentation contributions

The Young persons guide to programming source file is located at
Expand Down

0 comments on commit e52b665

Please sign in to comment.