Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 2.07 KB

Contributing to Alfred Web Searches

There are many ways you can contribute. You can:

  • 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.
  • Make suggestions and file bugs in Issues.
  • Fix issues and add features with Pull Requests.

Dependencies

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

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

Developing the workflow

  1. Clone this repo and run: alfred link inside it. This will make a symbolic link of the workflow directory.
  2. Running modd will start a process that will automatically build the workflow with alfred build on any changes you make to .go files. This builds and places a binary inside workflow directory.
  3. Make changes to the 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.

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

Sending PRs

  1. Fork repo
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Create new Pull Request

For bigger code changes, it's best to first discuss what you want to add in an issue.

Submitting a Pull Request

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

Thank you for taking the time to contribute! 💜