zeroclickinfo-goodies/README.md

31 lines
2.1 KiB
Markdown
Raw Normal View History

# Welcome to DuckDuckHack!
We're a community of open source developers from around the world, contributing code to improve the DuckDuckGo search engine.
2011-08-09 10:35:23 -07:00
2016-01-04 08:20:52 -08:00
### The Programming Mission
We want every programming search to have great results, providing the information you need instantly. The Programming Mission empowers the community to create Instant Answers for reference, libraries, help, and tools.
2014-12-24 09:56:31 -08:00
For now, we are **only accepting Pull Requests and Issues related to the Programming Mission**.
2013-03-11 09:37:20 -07:00
## How to contribute
- [**Create new Goodie Instant Answers, and improve existing ones**](https://github.com/duckduckgo/zeroclickinfo-goodies/issues?q=is%3Aopen+is%3Aissue+label%3A"Mission%3A+Programming")
- **Note**: Goodies are written in Perl (back-end) and JavaScript (front-end). They can also typically use CSS, and [Handlebars](http://handlebarsjs.com) Templates.
- [**Visit DuckDuckHack.com**](https://duckduckhack.com) to learn more about the Programming Mission, and how you can help us **analyze Instant Answer performance data** to determine new projects
2013-10-31 14:34:16 -07:00
2013-10-31 16:19:40 -07:00
### What are Goodie Instant Answers?
Goodies do not retrieve data from a third party API. Goodies provide their results entirely through server-side code. They may use a static data file stored on DuckDuckGo's server, but they do not call external resources.
#### Example: NPM Goodie
- [Code](https://github.com/duckduckgo/zeroclickinfo-goodies/blob/master/lib/DDG/Goodie/JsMinify.pm) | [Example Query](https://duckduckgo.com/?q=js+minifer&t=opera&ia=web) | [Instant Answer Page](https://duck.co/ia/view/js_minify)
![javascript minifier search](https://cloud.githubusercontent.com/assets/873785/20068349/626d9036-a4e6-11e6-945b-790bae2d2cdc.png)
## Resources
- Join the [DuckDuckHack Slack channel](https://quackslack.herokuapp.com/) to ask questions
- Join the [DuckDuckHack Forum](https://forum.duckduckhack.com/) to discuss project planning and Instant Answer metrics
- Read the [Goodie documentation](https://docs.duckduckhack.com/walkthroughs/calculation.html) for technical help
- View the list of [all live Goodie Instant Answers](https://duck.co/ia?repo=goodies&topic=programming) to see more examples