close
The Wayback Machine - https://web.archive.org/web/20201001044250/https://github.com/badges/shields/issues/5555
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

🎃 Convert Service Classes to Static Fields 🎃 #5555

Open
calebcartwright opened this issue Sep 19, 2020 · 16 comments
Open

🎃 Convert Service Classes to Static Fields 🎃 #5555

calebcartwright opened this issue Sep 19, 2020 · 16 comments

Comments

@calebcartwright
Copy link
Member

@calebcartwright calebcartwright commented Sep 19, 2020

We recently completed the upgrade to Node 12 in our production environment which, among other benefits, now allows us to leverage static fields for defining core attributes like the category and route.

We've completed the refactoring of several service classes to use static fields, but there's a lot of them remaining and we could use your help to convert the rest!

What are the steps required?

This work involves updating the members in a service class (found in the *-service.js files) to convert the static getters to static fields,

For example:

  static get category() {
    return 'version'
  }

becomes

  static category = 'version'

If a service class doesn't have any getters (e.g. redirector classes like this one, then there's nothing needed for that class!

Additional information and references can be found in the corresponding section of the tutorial documentation as well previous PRs that did this conversion like #5552 or #5530

How to contribute?

Below is the list of remaining service class families (as a link to their location in source) that need to be refactored. If you're interested in working on this, leave a comment on this thread or drop us a note in Discord letting us know which one(s) you'd like to work on. Items that have been checked off have already been completed, but the others are up for grabs!

As a rule of thumb, we'd generally prefer to see PRs contain between 2-4 refactored service class families to keep the review and merge process streamlined. You can work on as many as you'd like, but please try to follow that guidance when contributing and split PRs accordingly!

@jabbar86
Copy link
Contributor

@jabbar86 jabbar86 commented Sep 19, 2020

@calebcartwright I would like to contribute to this. Should I wait for hacktoberfest to start?

@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 19, 2020

Hi @calebcartwright I would love to work on some classes.I have posted the same message in discord with username cosmos

@calebcartwright
Copy link
Member Author

@calebcartwright calebcartwright commented Sep 19, 2020

@jabbar86

I would like to contribute to this.

Great! Please specify which of the service classes families you're going to work on so that we can prevent any duplicative efforts

Should I wait for hacktoberfest to start?

that's up to you! We'll happily accept help with this effort regardless of what month it is, but PRs submitted before Hacktoberfest begins will obviously not count towards your Hacktoberfest contributions

@ThakurKarthik

I would love to work on some classes.I have posted the same message in discord with username cosmos

Great! I've updated the above list to reflect the ones you've claimed

@jabbar86
Copy link
Contributor

@jabbar86 jabbar86 commented Sep 19, 2020

@calebcartwright Thanks I will contribute before hacktoberfest too. I will be working on.

homebrew
hsts
itunes
jenkins
jetbrains
@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 20, 2020

@calebcartwright can i work on this jira jitpack jsdelivr keybase , if no one else is working on those?

@jabbar86
Copy link
Contributor

@jabbar86 jabbar86 commented Sep 20, 2020

@calebcartwright I have finish #5555 (comment). I would like to take another modules i.e

lgtm
liberapay
librariesio
localizely
luarocks
@PyvesB PyvesB pinned this issue Sep 20, 2020
@jabbar86
Copy link
Contributor

@jabbar86 jabbar86 commented Sep 21, 2020

@calebcartwright I have completed #5555 (comment). Assign me

maven-metadata
microbadger
mozilla-observatory
myget
netlify

If anyone hasn't started working on it.Thanks

@jabbar86
Copy link
Contributor

@jabbar86 jabbar86 commented Sep 25, 2020

@calebcartwright Assign Me


nexus
node
nodeping
npm
nsp
@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 25, 2020

I am working on these services [nuget nycrc opencollective opm]

@monizb
Copy link

@monizb monizb commented Sep 29, 2020

@calebcartwright I would like to take up:

website
wercker
youtube
wheelmap
wordpress

Thanks :)

@vanhaaggen
Copy link

@vanhaaggen vanhaaggen commented Sep 29, 2020

@calebcartwright can i help out with these?

snyk | sonar | sourceforge | sourcegraph | spack

@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 30, 2020

Hey @calebcartwright if no one taken [ osslifecycle packagecontrol packagist pkgreview poeditor ] already I would like to work on them. Thanks !

@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 30, 2020

@RDIL feel free to pick any 4 - 5 services which are not done and post them here or at shields discord channel to prevent duplicate work.Thanks !

@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 30, 2020

@calebcartwright I am taking these files next [ powershellgallery pub puppetforge pypi ].

@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 30, 2020

@calebcartwright I have changes for the above services also.Meanwhile I am working on these services [readthedocs reddit redmine repology] and open PR once the previous changes get's accepted. Thanks !

@ThakurKarthik
Copy link
Contributor

@ThakurKarthik ThakurKarthik commented Sep 30, 2020

I am working on these too [ requires resharper,scoop scrutinizer] Thanks !

EDIT: @calebcartwright looks like there is nothing to work in resharper and scoop services. Please mark them as completed.

I am working on [security-headers, shippable] services

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.