zorn-v / nextcloud-social-login

GNU Affero General Public License v3.0
199 stars 138 forks source link

Documentation on contributing new providers? #244

Closed ostankin closed 3 years ago

ostankin commented 3 years ago

I would like to contribute a custom provider (Mail.ru). Since this provider is supported by the underlying library (Hybridauth), adding this provider takes adding a couple of lines (one to ProviderService.php and one to styles.scss) and a couple of SVG icons in img directory). I made this change locally on my own server and it works fine (see commit I prepared in my forked repo).

However, when I though about contributing this change officially, I stumbled upon a couple of questions:

  1. styles.css is obviously auto-generated from styles.scss. I used an online SCSS complier and CSS minifier, but I would like to generate it precisely the same way you did when building the project.
  2. I may have missed some other aspects necessary for the change to be complete.

Is there any guidance or checklist to go through in order to make a contribution?

P.S. The reason why I want to contribute this provider is because it can't be added via "Custom OAuth2" option - it has a very specific user profile retrieval, the custom algorithm can't be used for it.

zorn-v commented 3 years ago
  1. Just run npm run build
  2. All fine

PS. Better name it in lowercase as others. Exceptions is for classes (in hybridauth) with capital letter in middle.

ostankin commented 3 years ago

Thanks, converted to lowercase, rebuilt the project and submitted a pull request!