Mod Description Guidelines

In order to make things more clear to users, make an extensive description of your mod. Here are a couple of things you should have in mind:

• 1) Mod title
• 2) Snews version(s) the mod can be applied to
• 3) Mod author
  • a) Your name and/or forum nick
  • b) Your URI or some other contact feature
  • c) If the mod is created following some other publicly released code, please provide a link to the original code/author (fulfill the original code usage agreement)
• 4) Mod version and date of creation
  • a) If the mod is in beta development stage, use leading zero
    Mod 0.1, 0.2 …
  • b) If the mod has been proven stable, use numerical values
    Mod 1.0
  • c) Smaller improvements
    Mod 1.1, 1.2 …
  • d) Bigger changes
    Mod 2.0, 3.0 …
• 5) Mod description – a short description of mod behaviour
• 6) Mod dependancy – does it depend on some other mod? If does, provide the link to it and an explanation
• 7) Screenshots of public area to show the mod in action
  • a) Screenshots of admin area if needed
  • b) Screenshots should be done using Luka’s basic snews template to achieve visual uniformity
• 8) List of browsers/OS the mod is tested in
• 9) If required, list of PHP/MySQL versions the mod should work with
• 10) Known issues and/or bugs, if any, and an explanation how to generate them
• 11) Link to a live site with the mod in action (if possible)

An example of well-written mod description can be seen here.