arg/scriptcraft
Archived
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

updated contributing.md to refer to idiomatic js guide

Browse source
This commit is contained in:
walterhiggins 2014-01-30 00:03:07 +00:00
parent 621245adac
commit e52b665583
1 changed files with 18 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

28
contributing.md
View file

@ -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 +
@ -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