Skip to content
Peter Goodhall edited this page Mar 9, 2021 · 14 revisions

Work in progress to try to define some coding standards & rules to make things easier

  • ALL Code must be commented. (PRs without code comments will not be merged till added)
  • Code is Tabbed 4 Spaces (can be fixed if it's not)
  • Any Javascript where possible must be stored within a separate file within assets/js/sections unless otherwise not suitable.
  • New Controllers must have an associated method to match, this must contain ALL features for this item, do not add items to other models.
  • SQL queries must be limited and designed to be fast as possible this keeps Cloudlog fast as possible
  • Pull Request must be tested and if they aren't they will be rejected, no time frames given for merging its best efforts only.

Global Options

If you have a feature that requires a global configuration option that is something that is needed for logged in or logged out but isn't for just one user only then this should be placed in the Global 'options' table

The table has the following fields

  • option_name - the name of the option.
  • option_value - the options value
  • autoload - this is either "yes" or "no" and will mean the options loaded for everyone or not, things like usernames and passwords shouldn't be autoloaded.

Page Design

  • Page functional headings are H2

button colours

  • Blue Solid = Add something, activate something, or perform any other primary action.
  • Blue Outline = Edit, change or update something.
  • Red = Delete something or make an irreversible change.
  • Grey = Deactivate something.
  • Yellow = Reset something or clear a field (no permanent delete).
  • Green = Search.

Assets

Assets must be stored locally not CDNs and placed correctly within the /assets folder

Clone this wiki locally