search

alps-io / spec

ALPS Specification documents.
59 stars 13 forks source link

Clarify dependency management best practices #14

Open fosdev opened 11 years ago

fosdev commented 11 years ago

Document management guidelines to prevent externally consumed profiles that change causing ripple effects if you reference or extend them. Promises of consistency.

Applies To:

fosrias commented 4 years ago

So, this is the dreaded versioning issue. I can see guidelines being similar API guidelines:

  1. Don't take anything away.
  2. Don't change the meaning of something in an ALPS doc
  3. Don't make something required.

If you do version it.

As a consumer, you should ignore something that is in a profile but not in a related resource. In that way if new elements are in the ALPS profile but not the relate response, things are ok. This would also mean that code generated or using ALPS profile should ignore things it can't resolve, etc.

Do we need to address this now @mamund? I think it relates to https://github.com/alps-io/spec/issues/5 and maybe should be discussed as part of the thread/discussion I need to start there.