Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 1.39 KB
Raw

Contributing to Pretzel

We love your input! We also want to make the contributing process as easy as possible. Please follow these steps and guidelines:

  1. Fork the repo on GitHub.
  2. Create a text file with .yml as the file name. For example, Photoshop.yml.
  3. Find your app's shortcuts on the internet and add them to your .yml file. The yml file should be valid and follow these rules:
  • wrap both the shortcut keys and values in double quotes, such as "Quit App": "Cmd + q"
  • Replace ⌃ ⌘ ⌥ ⇧ by Ctrl Cmd Opt Shift , separated by spaces. I find doing so is best for usability and readability.
  • clean up any trailing whitespace.
  • take a look at the files in /shortcuts folder as an example.
  1. Install nvm and then run nvm install 8.11.3 to make sure you are running node v8 but not the latest. This is due to one of the dependencies - node-ffi - currently works on v8. My local node version is v8.11.3, but you should be able to use any node versions that's v8. Run nvm ls to make sure you are using the right version.
  2. Test your commit locally by running npm install && npm start. Navigate to your desired app and see if the shortcut shows up in Pretzel.
  3. Make a PR and I will merge it in and let you know.
  4. Once it's released, if you already have pretzel installed the app will notify you to install an update.

That's it. Thanks again for contributing!