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

Rewrite GitHub services #2320

Closed
paulmelnikow opened this issue Nov 15, 2018 · 8 comments
Closed

Rewrite GitHub services #2320

paulmelnikow opened this issue Nov 15, 2018 · 8 comments
Labels
good first issue New contributors, join in! service-badge Accepted and actionable changes, features, and bugs

Comments

@paulmelnikow
Copy link
Member

paulmelnikow commented Nov 15, 2018

In #2253 I got the ball rolling with rewriting the GitHub services. The changes to the service in that PR are a good model for rewriting any of the remaining services.

You can ignore the changes to the base services and to the GithubAuthService.

There have been some small enhancements to BaseService since then which should also be taken into account: #2278 #2279 (and #2308 once it's merged)

If folks are comfortable taking any of the remaining LegacyServices in services/github/ and rewriting them along the lines of #2253, please give it a go!

At the moment there's also a pull request open (#2309) to move the rest of the GitHub badge examples into services/github/, though that hopefully will be merged soon.

Ref #1358

@paulmelnikow paulmelnikow added good first issue New contributors, join in! service-badge Accepted and actionable changes, features, and bugs labels Nov 15, 2018
@paulmelnikow
Copy link
Member Author

If anyone is interested in helping with this, we've now got some tips!

https://github.com/badges/shields/blob/master/doc/rewriting-services.md

@paulmelnikow
Copy link
Member Author

Seems like we may as well close this out in favor of #2863. Is there any more info we should add there related to the GitHub services? Maybe pointers to some which are done?

@calebcartwright
Copy link
Member

Once I split out the GH services in our spreadsheet, I can add the remaining list of GH services needing refactor in here for reference, and links to the classes that have already been refactored.

Given the number of GH services and some of the complexity I think it may also make sense to add a pointer over to here from #2863

Thoughts?

@paulmelnikow
Copy link
Member Author

I think it's fine to track it here. We could pin this one too.

I feel like what I've written above is targeting maintainers and I feel too embedded with this work to provide the right amount of context.

What would you think about tackling one of these to make a clean example, and rewriting the top post (a la #2863)?

@calebcartwright
Copy link
Member

Sure, will do

@calebcartwright
Copy link
Member

I've finished splitting out the GH services in the spreadsheet. On second thought I don't want to add them inline here as it will inevitably slide out of date, but I'll pick out one to refactor and update this accordingly

@paulmelnikow
Copy link
Member Author

These have gotten easier!

#3095 #3098 #3099

@paulmelnikow
Copy link
Member Author

Just three of these left! Let's track at #2863 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue New contributors, join in! service-badge Accepted and actionable changes, features, and bugs
Projects
None yet
Development

No branches or pull requests

2 participants