From 9384b0d69e0c3a4b862d78a0ce4e395c29e9b7a1 Mon Sep 17 00:00:00 2001 From: Zaahir Moolla Date: Mon, 7 Nov 2016 12:40:33 -0500 Subject: [PATCH] Update README, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE (#3737) * Update README, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE Mimicing updates to Spice and Fathead repos * Correct live Goodies link --- .github/ISSUE_TEMPLATE.md | 37 ++++++++++++++++---------------- .github/PULL_REQUEST_TEMPLATE.md | 27 +++++------------------ README.md | 37 +++++++++++++++++++------------- 3 files changed, 46 insertions(+), 55 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index fec4cd007..e3e615dcf 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,29 +1,17 @@ - -## Type of Issue - - -- [ ] Bug (incorrect behavior) - - [ ] Triggering - - [ ] Relevancy - - [ ] Internal (issue with code) -- [ ] Feature Request - - [ ] Triggers (new triggers) - - [ ] Design Change - - -## Description - +### Description + ## Steps to recreate @@ -33,8 +21,21 @@ ## People to notify + --- Instant Answer Page: https://duck.co/ia/view/{ID} + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 560aa0e79..d162a726f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,24 +4,12 @@ {IA Name}: {Description of change} For a New Instant Answer: - New {IA Name} Goodie/CheatSheet + New {IA Name} Goodie For anything else: {Tests/Docs/Other}: {Short Description} --> -## Type of Change - - -- [ ] New Instant Answer - - [ ] Cheat Sheet -- [ ] Improvement - - [ ] Bug fix - - [ ] Enhancement -- [ ] Non–Instant Answer - - [ ] Other (Role, Template, Test, Documentation, etc.) - - ## Description of new Instant Answer, or changes @@ -32,16 +20,11 @@ ## People to notify - - + + --- - -IA Page: https://duck.co/ia/view/{ID} - - - - -Forum Topic: +Instant Answer Page: https://duck.co/ia/view/{ID} + diff --git a/README.md b/README.md index 14b09eda3..f4b57dd01 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,30 @@ -# Welcome to DuckDuckHack! +# Welcome to DuckDuckHack! +We're a community of open source developers from around the world, contributing code to improve the DuckDuckGo search engine. -[![Build Status](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies.png?branch=master)](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies) -![](http://docs.duckduckhack.com/assets/hack search engine.png) +### 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. -We're a community dedicated to improving search results with open source, "Instant Answers." Instant Answers use the Web's best APIs and data to solve searches in few or zero clicks. Together and openly, we can create the best search engine for every type of search. +For now, we are **only accepting Pull Requests and Issues related to the Programming Mission**. -**The DuckDuckHack community and DuckDuckGo staff are working together on a mission to create the best search engine for programmers. To fully focus there, we are only accepting Pull Requests and Issues related to the [Programming Mission](https://forum.duckduckhack.com/t/duckduckhack-programming-mission-overview/53).** By working directly with contributors to this mission, we can more quickly provide search data and open source tools which give contributors and their Instant Answers more impact than ever before! -[**Join the Programming Mission!**](https://forum.duckduckhack.com/t/duckduckhack-programming-mission-overview/53) -*Your help and expertise can have a huge impact on improving the search experience for developers and DuckDuckGo users around the world!* +## 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 -More Resources: -*[Full documentation](http://docs.duckduckhack.com)* -*[Instant Answers in Production](https://duck.co/ia)* -*[Instant Answers in Beta](https://beta.duckduckgo.com/?q=test&t=hc&ia=iatesting&iax=1)* -Instant Answers appear at the top of search results... -![](http://docs.duckduckhack.com/assets/python_apply_at_DuckDuckGo.png) +### What are Goodie Instant Answers? +Goodies retrieve data from third-party JSON APIs. An API call is generated at the time of the query, and the JSON data returned is used to build an Instant Answer result on the front-end. -Attribution is shown for developers who create or improve them... -![](http://docs.duckduckhack.com/assets/attribution_example_1.png) +#### 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