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

Incorporate newer `key` API method in place of the deprecated `which` method #211

Open
rexagod opened this Issue Apr 12, 2019 · 9 comments

Comments

Projects
None yet
3 participants
@rexagod
Copy link
Collaborator

rexagod commented Apr 12, 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.

📋 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: In order to remove support for the deprecated which method, we'll be replacing it by the key method, while making some other appropriate changes as well. The steps are as follows.

  • Replace the following key map values to comply with the key method, i.e., with the keymap provided below it.

    keymap: {
    8: '_removeOverlay', // backspace windows / delete mac
    46: '_removeOverlay', // delete windows / delete + fn mac
    20: '_toggleRotate', // CAPS
    27: '_deselect', // esc
    68: '_toggleRotateDistort', // d
    69: '_toggleIsolate', // e
    73: '_toggleIsolate', // i
    74: '_sendUp', // j
    75: '_sendDown', // k
    76: '_toggleLock', // l
    79: '_toggleOutline', // o
    82: '_toggleRotateDistort', // r
    83: '_toggleScale', // s
    84: '_toggleTransparency', // t
    }

		keymap: {
			'Backspace': '_removeOverlay',
			'Delete': '_removeOverlay',
			'CapsLock': '_toggleRotate',
			'Escape': '_deselect',
			'd': '_toggleRotateDistort',
			'r': '_toggleRotateDistort',
			'i': '_toggleIsolate',
			'j': '_sendUp',
			'k': '_sendDown',
			'l': '_toggleLock',
			'o': '_toggleOutline',
			's': '_toggleScale',
			't': '_toggleTransparency',
		}
handlerName = keymap[event.key];
  • 💾 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!

@rexagod

This comment has been minimized.

Copy link
Collaborator Author

rexagod commented Apr 12, 2019

Pinging @jywarren, @sashadev-sky, or @gauravano to mark this as an fto. Please refer #178 for context.

@sashadev-sky

This comment has been minimized.

Copy link
Collaborator

sashadev-sky commented Apr 13, 2019

@rexagod ok cool! Did you look up if this is the new convention for keymaps? I know I said key but like I said wasn't positive!! But it makes sense, right?

@sashadev-sky

This comment has been minimized.

Copy link
Collaborator

sashadev-sky commented Apr 13, 2019

making a candidate until you get back to me on that. Also did you make these changes locally and everything still worked?

@rexagod

This comment has been minimized.

Copy link
Collaborator Author

rexagod commented Apr 13, 2019

@sashadev-sky I did look up the convention and compatibility of the key method and this seems to fit in. Also, I've verified this locally, you can be sure.

@sashadev-sky

This comment has been minimized.

Copy link
Collaborator

sashadev-sky commented Apr 15, 2019

@rexagod Looks good! Changing this to an FTO. I'll post it in the plots2 FTO page for you so people see it. Is the plan to update all of them through a bunch of FTOs?

@SteliosPhanartzis

This comment has been minimized.

Copy link

SteliosPhanartzis commented Apr 15, 2019

Can I claim this?

@sashadev-sky

This comment has been minimized.

Copy link
Collaborator

sashadev-sky commented Apr 15, 2019

@SteliosPhanartzis Yes all yours!

@SteliosPhanartzis

This comment has been minimized.

Copy link

SteliosPhanartzis commented Apr 15, 2019

Was the DistortableImage.Edit.js the only file that had the which method?

@sashadev-sky

This comment has been minimized.

Copy link
Collaborator

sashadev-sky commented Apr 15, 2019

@SteliosPhanartzis yes the only one that's currently in use. Don't worry about standardizing with the rest of the repo, the FTOs are meant to be a smaller, step by step situation.

You can open a new PR once you're done with this to make more updates if you'd like!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.