Skip to content

Instantly share code, notes, and snippets.

@umbrae

umbrae/gist:3441681

Created August 23, 2012 21:00
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save umbrae/3441681 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save umbrae/3441681 to your computer and use it in GitHub Desktop.
Download ZIP
Etsy API Backwards Incompatible Change - Disclosure Template
Raw
gistfile1.md

[ANNOUNCE] Backwards Incompatible Change: {Type of Change}

What is the change being made?

(A clear, concise summary of the change that needs to be made)

What is the scope of this change?

(A list of all affected resources, methods, and associations, with links.)

Why is this change being made?

(A no-BS description of the business need for this change, and why it's worth it to inconvenience our third parties.)

What is the workaround, or new syntax, for these changes?

(A complete description how API clients can alter their workflow to continue to provide the value that was being provided before. The phrasing here is intentional: As a rule, we will not be considering backward incompatible changes without a workaround. In the case where we absolutely cannot provide a workaround, we'll be disclosing that here.)

What is the timeframe for these changes?

(At a minimum, 2 weeks will be given for even the smallest of backward incompatible changes. Usually 4 weeks. We'll be polling early when we can to determine the effects of these changes before announcement, and opening up the floor for affected users to shout in discuss and receive more time if they need it.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment