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

Spec improvements #3

Open
dometto opened this issue Apr 16, 2015 · 0 comments
Open

Spec improvements #3

dometto opened this issue Apr 16, 2015 · 0 comments

Comments

@dometto
Copy link
Member

dometto commented Apr 16, 2015

Suggestions by @SkyCrawl:

  • Things like Gollum::BlobEntry should be moved from gollum-lib to adapter_specs (gollum-lib should require and use an adapter, just like it is now, but all git-related types and methods should be defined there),
  • I imagine it would be a lot better if adapter_specs defined fully documented communication between underlying git layer and gollum-lib (types and module methods), instead of some "vague descriptions" (if possible, of course). In other words:
    • gollum-lib would only reference methods and instance variables defined in adapter_specs and its types,
    • all methods of adapter_specs should only define arguments and return objects of types predefined in adapter_specs (or primitive types),
    • all methods that require custom implementation should have their skeleton defined (and documented) in adapter_specs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant