search

samvera-labs / hydra_plugins_wg

Work area for the Hydra Plugins Working Group
Apache License 2.0
1 stars 0 forks source link

Adds justification for notifying of host app changes #62

Closed afred closed 6 years ago

afred commented 7 years ago

Specifically during a failed installation. But this notification should probably happen regardless.

Closes #42.

cjcolvar commented 7 years ago

It seems like this guideline overlaps with "Plugins should print meaningful error messages in case of a failure during installation." I agree some meaningful feedback can be nice at the end of running a generator (or ad-hoc script) whether it was a failure or success.

afred commented 7 years ago

This is more to cover the following scenario:

  1. start plugin installation
  2. plugin injects a module inclusion into a class in the host application (e.g. to add some plugin-specific behavior to a controller, or model, or whatever)
  3. plugin fails for some reason, and prints a nice error message as to why
  4. But if the implementer isn't made aware of the injected code, then they're in a bad state.
cjcolvar commented 7 years ago

I still think it might be best rolled into that guideline, but I'm okay with this. Maybe change the last two words to "if necessary" to avoid using "need" twice in one sentence?