Contributing Information.

Jump to bottom

Nathan Gibbs edited this page May 28, 2023 · 10 revisions

How to contribute to BASE.

Code.
- See our Contributing guide.
- Tabs not spaces.
- Remember, BASE is designed to support PHP from 4.0.4 to present.
  - Code with compatibility in mind.
- PHPUnit tests where possible.
  - Code with compatibility in mind.
Iconography.
- Size: 96x96 pixels.
- Background: transparent.
- File format: png
- File Names: base_icon_$set_$desc.png
  - $set: Integer denoting Icon set.
  - $desc: String denoting icon purpose / functional description.
  - Example: base_icon_3_barbecue.png, is part of icon set 3 and may indicate the barbecue action in the app.:smile:
  - Currently defined Icon Sets: $set
    - 0: Default BASE Icon Set.
  - Currently defined descriptions: $desc
    - Delete: delete - Indicates a deletion action.
    - Edit: edit - Indicates an editing action.
    - Exclamation: exclamation - Indicates something the user should be aware of.
    - No: no - Indicates the absence of something, a disable action, or action cancellation.
    - Yes: yes - Indicates the presence of something, an enable action, or action confirmation.
    - Search: search - Indicates a search action.
    - Graph: graph - Indicates a charting or graphing action.
    - Tools: tool - Indicates an option to repair something.
    - Auth: auth - Indicates Authentication System information or action.
    - User: user - Indicates User account specific information, input, or action.
    - Password: password - Indicates User credentials specific information, input, or action.