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

Changing single line comments to multiple lines comment (target multiple lines) #1204

Closed
5 tasks
leumasxxx opened this issue Oct 20, 2022 · 6 comments · Fixed by #1208
Closed
5 tasks

Changing single line comments to multiple lines comment (target multiple lines) #1204

leumasxxx opened this issue Oct 20, 2022 · 6 comments · Fixed by #1208

Comments

@leumasxxx
Copy link
Contributor

leumasxxx commented Oct 20, 2022

Hi, 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 underrepresented groups in free and open-source software!

We know that the process of creating a pull request is one of the biggest barriers 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.

📋 Step by Step

  • 🙋 Claim this issue: Claim the issue by commenting. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
💡 Learn how to claim 🙋

Claiming an issue

Unless the issue is marked as reserved for someone, you can just say "I'd like to try this!" and then you've claimed it - no need to wait for someone to assign it to you. Just be sure you link your pull request (PR) to this issue so we can see where your solution is.

And open one early if possible - even before you've completed it with additional commits - and others can help you figure out any issues you may face.

  • 📝 Update the file DoubleClickZoom.js in the Leaflet.DistortableImage repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

-65 // in `DoubleClickLabels.js`, we just do map.fire('dblclick') bc `_onDoublClick` doesn't use the
+65 /*  in `DoubleClickLabels.js`, we just do map.fire('dblclick') bc `_onDoublClick` doesn't use the
-66// passed "e" (for now). To generate a 'real' DOM event that will have all of its corresponding core
+66 passed "e" (for now). To generate a 'real' DOM event that will have all of its corresponding core
-67// properties (originalEvent, latlng, etc.), use Leaflet's `#map._fireDOMEvent` (Leaflet 1.5.1 source)
+67 properties (originalEvent, latlng, etc.), use Leaflet's `#map._fireDOMEvent` (Leaflet 1.5.1 source) */
  • 💾 Commit your changes

  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can also edit files directly in your browser and open a pull request from there.

  • 🏁 Done Ask in comments for a review :)

🤔❓ Questions?

Leave a comment below!

Is someone else already working on this?

We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. If someone seem stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

(This issue was created by First-Timers-Bot.)

@leumasxxx
Copy link
Contributor Author

@jywarren @TildaDares I stumbled on this while going through https://github.com/publiclab/Leaflet.DistortableImage/blob/main/src/mapmixins/DoubleClickZoom.js file and I noticed that we can modify the comment made from line 65 to 67, Instead of commenting each line we can target all three lines which makes the code look more ethical and i also think it's a good first timer issue

@Oluwaseun241
Copy link
Contributor

Can I claim the issue??

@TildaDares
Copy link
Member

Hi @leumasxxx, thank you for opening this issue. Looks great!

@TildaDares
Copy link
Member

Hi @Oluwaseun241, please go ahead. Thank you!!

@Oluwaseun241
Copy link
Contributor

Hi @Oluwaseun241, please go ahead. Thank you!!

Done ready to be review

@leumasxxx
Copy link
Contributor Author

you're welcome @TildaDares

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

Successfully merging a pull request may close this issue.

3 participants