Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

45 lines (39 loc) · 2.49 KB

#CONTRIBUTING

Obey the following standards when contributing to the Github.

#Things that should not be in your code or icon files:

  1. Backdoors for specific people
  2. if(prob(100))
  3. Anything that can kill anyone on the server in seconds
  4. Anything that can kill the server in seconds
  5. Anything directly copy pasted from a closed/leaked code base of SS13 (Goon for instance); permission granted nulls this rule.
  6. Anything that lags the server
  7. ERP
  8. Multiple "in world" calls in one proc
  9. Anything that expands its tile (32x32) unless its broken into 32x32 tiles
  10. Massively animated icons (We are talking very large animations])
  11. Anything that requires access to savefiles, bans, jobbans, notes, etc (unless noted)

#Sound file rules

  1. .ogg is recommended
  2. .ogg compressed at 7
  3. If the sound has the same two stereo tracks; make it mono
  4. 22050HZ with a 16-bit PCM
  5. Midi files are allowed
  6. Ensure your soundfile is as small as possible; cut out parts if its music
  7. Title music doesn't require the previous rule

#Do not mess with

  1. Anything in the config folder
  2. Specifically admin names

#Nalar's Coders Edicts

  1. Thou shalt not add uninformative or useless comments. Thy comments shall remain informative, descriptive, and serve a purpose.
  2. Thou shalt not copy and paste. Thy code shalt be made by yourself and serve thy needs. Thou shalt tar and feather violators.
  3. Thou shalt not create unnecessary or unused variables.
  4. Thou shalt remain consistent. Thy code will follow a consistent format. Thy interface elements will remain consistent with the rest.
  5. Thy procedures shalt not be named using different conventions (camel case, lower case with underscores). Thy variables will follow a similar format.
  6. Thou shalt not cause lag. Thy code will not cause more stress than necessary. Looping will not be undertaken more than required. Del will be used only where it cannot be avoided and where qdel will not suffice. Procedures will remain efficient in their purpose.
  7. Thou shalt not cause runtime errors. Thy code will contain sanity checks, and thou will not attempt to check objects that doth not contain variables or information thou needs to access. Thou shalt use absolute paths for objects.
  8. Thou shalt test code before committing to the repository.
  9. Thou shalt not commit code not ready to be used on the server.

#Additionally

  1. Do not take credit for others work
  2. Understand HippieStation's style (LightRP)
  3. Users of the coder rank should refer to the specific standards on the forum