Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 2.03 KB

Contributing to Alfred Web Searches

Thank you for taking the time to contribute! ♥️

You can:

  • Submit bug reports or feature requests
  • Fix open issues and create PRs
  • Edit the CSV file and add more web searches to the workflow. It has a simple structure of argument, followed by comma and then what website is going to be searched. Where {query} will be replaced by the search query.
  • Improve documentation, the code and more! These are just some ideas.

Dependencies

The workflow is written in Go and uses AwGo library for all Alfred related things.

It uses modd and Alfred command to help with its development.

To run the project:

  1. Clone the repo (git clone https://github.com/nikitavoloboev/alfred-web-searches)
  2. Run alfred link (makes symbolic link of workflow directory)
  3. Run modd (starts a process that automatically builds the workflow with alfred build on any changes you make to .go files, this builds and places a binary inside workflow directory.)
  4. Make changes to code or modify Alfred objects to do what you want! Open debugger in Alfred or run the workflow with workflow:log passed in as argument to see the logs Alfred produces.

Have fun! 🚀

You can also read how to write Alfred workflows in Go.

Opening PRs

Please search existing issues and pull requests to check if somebody else is already working on the issue.

Don't be afraid to ask questions, open issues for discussion or opening Draft PRs with code.