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

Update L.DistortableImage.Edit.js method creation to ES6 syntax #718

Closed
12 tasks
sashadev-sky opened this issue Aug 25, 2020 · 7 comments · Fixed by #761
Closed
12 tasks

Update L.DistortableImage.Edit.js method creation to ES6 syntax #718

sashadev-sky opened this issue Aug 25, 2020 · 7 comments · Fixed by #761

Comments

@sashadev-sky
Copy link
Member

First Time?

This is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

The problem

We just added support for ES6 in our library, and would like to start transitioning our code to use this syntax.

Let's update the method creation syntax from ES5 to ES6 for several methods in src/edit/DistortableImage.Edit.js.

Solution

For the following 6 L.DistortableImage.Edit methods, remove the function keyword and attach the method arguments to the method name instead:

  • initialize
  • addHooks
  • removeHooks
  • disable
  • _initModes
  • _initHandles

Here is an example of how this will look for a different method. These ones should follow suit:

ES5

radiansToDegrees: function(angle) {
  return (angle * 180) / Math.PI;
},

ES6

radiansToDegrees(angle) {
  return (angle * 180) / Math.PI;
},

Thanks!!

Step by Step

  • Claim this issue with a comment here, below, and ask any clarifying questions you need
  • Fork the repository and set it up locally following the main repo README instructions https://github.com/publiclab/Leaflet.DistortableImage
  • Create a new feature branch with a unique name descriptive to the issue
  • Try to fix the issue following the steps above, but even before you're done, you can:
    commit your changes to your branch and start a pull request (see contributing to Public Lab software) but mark it as "in progress" if you have questions or if you haven't finished
  • Reference this issue in your pull request body
  • Once you submit your pull request, if there's an additional checklist provided for getting it merged, get those boxes checked off. Either way, mention me @sashadev-sky for a review.

Please keep us updated

💬⏰ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

💬 Get help

If you need any help - here are some options:

@sashadev-sky
Copy link
Member Author

assigned to @jugalj05hi!

@javed24
Copy link
Contributor

javed24 commented Aug 25, 2020

hi @sashadev-sky , first timer here, would love to help with this!

edit: just noticed that it's already been assigned. LMK if it still needs more work though 🙏

@sashadev-sky
Copy link
Member Author

@javed24 i assigned u to #587!

@jugalj05hi
Copy link

@sashadev-sky getting this error when pushing the local branch on the repo.
image

@javed24
Copy link
Contributor

javed24 commented Aug 26, 2020

@sashadev-sky getting this error when pushing the local branch on the repo.
image

did you fork this repo? The PR has to be from your forked branch to the base/main one.

@SeaverDahlgren
Copy link
Contributor

Hi, I would like to work on this issue.

@Arya-Abhishek
Copy link

Hi, Can I work on this? @sashadev-sky

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment