Support #451

Create `template` for new data source

Added by tshif over 1 year ago. Updated over 1 year ago.

Status:Assigned Start:12/29/2010
Priority:High Due date:
Assigned to:tshif % Done:

0%
Category:Planning
Target version:Caller ID Superfecta Source Files

Description

In order to reduce the amount of reworking that is needed to bring contributed data source scripts into conformance with our known best practices, we should create a data source template that can be used by contributors.

  1. Fully support debug remarks, successes, failure, and errors.
  2. Have a standardized section to include valid NAPA (Etc, al.) for the data source
  3. Have a standard section and way of dealing with SPAM flags for inbound calls. (I.E., use the SPAM FLAG)
  4. Have a standard Report-back section where best structure and process for report back is deployed
  5. Include possibly needed configuration code examples (ID / PW, etc.)

I think there are several good candidates in the collection of data sources we already have to serve as a starting point - but It should fall to a programmer to determine which approaches are best for each section of the data source, and help create the ideal framework data source.

The sooner this template becomes ready for use and available, the sooner the rework-load on the devs will be reduced.

History

Updated by tshif over 1 year ago

tshif wrote:

In order to reduce the amount of reworking that is needed to bring contributed data source scripts into conformance with our known best practices, we should create a data source template that can be used by contributors.

[...]

I think there are several good candidates in the collection of data sources we already have to serve as a starting point - but It should fall to a programmer to determine which approaches are best for each section of the data source, and help create the ideal framework data source.

The sooner this template becomes ready for use and available, the sooner the rework-load on the devs will be reduced.

Updated by jkiel over 1 year ago

While I like the idea of templates, sometimes a working example is best.

I wonder it it may not be better (and easier) to select a few sources, clean them up and comment them very, and then point potential source developers to these model sources.

Updated by tshif over 1 year ago

  • Status changed from Feedback to Assigned
  • Assigned to set to tshif

Also available in: Atom PDF