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

Fix Typo In EdgeDetect Module #884

Closed
5 tasks
harshkhandeparkar opened this issue Mar 18, 2019 · 6 comments
Closed
5 tasks

Fix Typo In EdgeDetect Module #884

harshkhandeparkar opened this issue Mar 18, 2019 · 6 comments

Comments

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Mar 18, 2019

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 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.

To Do: Fix a typo in EdgeDetect module source code which doesn't affect functionality but is better to be fixed.

📋 Step by Step

  • 🙋 Claim this issue: Comment below. 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 Module.js in the image-sequencer repository (press the little pen Icon) and edit the line as shown below.

Change options.hystereis to options.hysteresis
Here

options.hystereis = options.hysteresis || defaults.hysteresis;

And here

pixels = require('./EdgeUtils')(pixels, options.highThresholdRatio, options.lowThresholdRatio, options.hystereis);

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:

On line 10

-  options.hystereis = options.hysteresis || defaults.hysteresis;
+  options.hysteresis = options.hysteresis || defaults.hysteresis;

And on line 30

-      pixels = require('./EdgeUtils')(pixels, options.highThresholdRatio, options.lowThresholdRatio, options.hystereis);
+      pixels = require('./EdgeUtils')(pixels, options.highThresholdRatio, options.lowThresholdRatio, options.hysteresis);
  • 💾 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

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 with a request for more time or help, 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.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔❓ Questions?

Leave a comment below!

@harshkhandeparkar
Copy link
Member Author

harshkhandeparkar commented Mar 18, 2019

This issue is reserved for @Jaya738. You can resolve this at anytime and take as much time as you want but please let us know that you are working on this. Issue #885 is reserved for @An0u but you two can exchange issues if both agree. If you have any doubts, we are ready to help. Thank you!

@harshkhandeparkar
Copy link
Member Author

If a newcomer wants to solve an issue, they can get their name added to the list in #842

@Michaellin250
Copy link

Can I work on this issue?

@harshkhandeparkar
Copy link
Member Author

Go ahead!

@scheleon
Copy link

Is this issue assigned? I would love to work on it

@harshkhandeparkar
Copy link
Member Author

It is already fixed. Sorry but I can add your name to the list in #842

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

No branches or pull requests

3 participants