notify icon indicating copy to clipboard operation
notify copied to clipboard

ci(service): Set standards and add review process for external services that are candiates for integration

Open nikoksr opened this issue 4 years ago • 5 comments

Is your feature request related to a problem? Please describe.

This is related to j-wil's comment in the discussion about the testing procedure for external services. We currently have no standards for external services that are integrated into notify, even though certain minimum requirements have of course been taken into account up to now.

Describe the solution you'd like

As suggested by @j-wil, we need some sort of review process for the libraries behind the services that are potentially to be integrated. I suggest that we keep creating issues in style of #5 to propose the integration of a new service and that in the comment section of this issue we discuss which candidate would be the best fit for notify.

Suggestions for possible criteria:

  • Has the library been published directly by the vendor/developer of the service in question?
  • Does the library work at all?
  • Is the library still being actively developed/maintained?
  • Is the library reasonably popular relative to the popularity of the overriding service? (This is a rather weak criterion, but could be helpful in case we are between two equal candidates).

Please suggest other criteria in the comments or critique the example criteria given if needed.

nikoksr avatar Feb 03 '21 15:02 nikoksr

Possible Criteria:

  • Test coverage > 90%
  • Go Report Card > B+
  • Codacy > B+
  • A clean License scan
    • This is included post-integration but we could use it as a way to vet projects pre-integration so we don't find ourselves in a corner

@nikoksr I can take on the task of running all current integrations against these and writing up a simple section in the readme discussing our criteria for integration so that possible users feel comfortable that we have done our homework.

j-wil avatar Feb 03 '21 16:02 j-wil

@j-wil that would be great!

nikoksr avatar Feb 03 '21 17:02 nikoksr

@j-wil just to conclude; current list of criteria:

  • A library that was published directly by the vendor/developer of the service is preferable
  • Does the library work at all?
  • Is the library still being actively developed/maintained?
  • Test coverage > 90%
  • Go Report Card > B+
  • Codacy > B+
  • A clean License scan

nikoksr avatar Feb 22 '21 15:02 nikoksr

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Apr 23 '21 17:04 stale[bot]

It my great desire to have this project work

zafania avatar Aug 16 '21 13:08 zafania