rom-rb.org icon indicating copy to clipboard operation
rom-rb.org copied to clipboard

Guide for authors interested in writing adapters and extensions

Open maetl opened this issue 10 years ago • 1 comments

This would help fill some of the gaps in knowledge around extensions and take some of the pressure off the contributors guide (see: #43), in terms of helping people to ramp up as contributors to ROM.

A guide should address the following details:

  • The range of different possibilities for extending ROM
  • The kinds of things that we want to see built
  • High level description of the dataset and repository interface; examples from existing adapters
  • Provided API hooks for extensions to work with
  • How to write code that plays nicely with ROM
  • Naming things
  • Required git repo layout, gem spec, module, and testing structure

maetl avatar Mar 03 '15 01:03 maetl

:+1: this definitely deserves a separate sub-section in "guides"

solnic avatar Mar 03 '15 11:03 solnic