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

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

Open
nikoksr opened this issue Feb 3, 2021 · 5 comments
Labels
help wanted Extra attention is needed type/feature New feature or request

Comments

@nikoksr
Copy link
Owner

nikoksr commented Feb 3, 2021

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 nikoksr added type/feature New feature or request help wanted Extra attention is needed affects/services Issue or PR related to a notification service. labels Feb 3, 2021
@j-wil
Copy link
Collaborator

j-wil commented Feb 3, 2021

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.

@nikoksr
Copy link
Owner Author

nikoksr commented Feb 3, 2021

@j-wil that would be great!

@nikoksr nikoksr mentioned this issue Feb 17, 2021
5 tasks
@nikoksr
Copy link
Owner Author

nikoksr commented Feb 22, 2021

@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

@stale
Copy link

stale bot commented Apr 23, 2021

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 stale bot added the wontfix This will not be worked on label Apr 23, 2021
@stale stale bot closed this as completed Apr 30, 2021
@nikoksr nikoksr removed the wontfix This will not be worked on label Aug 14, 2021
@nikoksr nikoksr reopened this Aug 14, 2021
@zafania
Copy link

zafania commented Aug 16, 2021

It my great desire to have this project work

@nikoksr nikoksr removed the affects/services Issue or PR related to a notification service. label Apr 25, 2022
Repository owner deleted a comment from zafania Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed type/feature New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants