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!

• 📝 Update the file listeners.html in the https://github.com/publiclab/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:

In file listeners.html, insert <script src="./js/listeners.js" defer></script> in the header section and then apply the diff below.

- <script>
-   var map;
-
-   (function(){
-     map = L.map('map').setView([51.505, -0.09], 13);
-     map.addGoogleMutant();
-
-     map.whenReady(function() {
-       img = L.distortableImageOverlay('example.jpg', {
-         selected: true,
-       }).addTo(map);
-
-       // Wait until image is loaded before setting up DOM element listeners
-       L.DomEvent.on(img.getElement(), 'load', function() {
-         L.DomEvent.on(img, 'edit', function() { alert('edited'); });
-         L.DomEvent.on(img.getElement(), 'mouseup touchend', function() { alert('edited'); });
-       });
-     });
-   })();
- </script>

Create file listeners.js in folder /examples/listeners.js and apply the diff below:

+     var map;
+
+     (function(){
+       map = L.map('map').setView([51.505, -0.09], 13);
+       map.addGoogleMutant();
+
+       map.whenReady(function() {
+         img = L.distortableImageOverlay('example.jpg', {
+           selected: true,
+         }).addTo(map);
+
+         // Wait until image is loaded before setting up DOM element listeners
+         L.DomEvent.on(img.getElement(), 'load', function() {
+           L.DomEvent.on(img, 'edit', function() { alert('edited'); });
+           L.DomEvent.on(img.getElement(), 'mouseup touchend', function() { alert('edited'); });
+         });
+       });
+     })();

• 💾 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.)