Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide for authors interested in writing adapters and extensions #51

Open
maetl opened this issue Mar 3, 2015 · 1 comment
Open

Guide for authors interested in writing adapters and extensions #51

maetl opened this issue Mar 3, 2015 · 1 comment
Labels

Comments

@maetl
Copy link
Contributor

maetl commented Mar 3, 2015

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
@solnic
Copy link
Member

solnic commented Mar 3, 2015

👍 this definitely deserves a separate sub-section in "guides"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants