Skip to content
This repository has been archived by the owner on Jul 21, 2023. It is now read-only.

Latest commit

 

History

History
34 lines (23 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.09 KB
Raw

Contributing

In general this project follows the standard pattern for making contributions, namely:

  1. fork this repo
  2. make a feature branch
  3. commit your changes to the feature branch
  4. propose feature branch as a pull request

Branch Structure

The devel branch is where all primary work is merged.

Tags are created for releases, and release branches will be created if there is ever a need for backfix porting.

Feature branches should be propsed for pull requests.

Code structure

The code is organized into 2 primary modules: contexts and interfaces.

The interfaces module contains code that translates the on-disk files into in-memory representations. This is the place to add new interactions with data from the must-gather.

The contexts module contains code that adapts a interface data into variables that can be used within the templates. This is the place to control how data is injected from the on-disk format to a template so that it can be rendered in the browser.

The okd_camgi/templates directory contains the HTML template that is used to render the final output.