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 linkmaster
Zaahir Moolla
GitHub
parent
0e8ba0a075
commit
9384b0d69e
|
|
@ -1,29 +1,17 @@
|
|||
<!-- Please use the appropriate format for your Issue title:
|
||||
<!-- Please use the appropriate issue title format:
|
||||
|
||||
For a Bug Fix:
|
||||
BUG FIX
|
||||
{IA Name} Bug: {Short description of bug}
|
||||
|
||||
For a Suggestion
|
||||
SUGGESTION
|
||||
{IA Name} Suggestion: {Short description of suggestion}
|
||||
|
||||
For anything else:
|
||||
OTHER
|
||||
{IA Name}: {Short description} -->
|
||||
|
||||
|
||||
## Type of Issue
|
||||
<!-- Place and 'X' in the correct box (E.g `[X] Triggering`) -->
|
||||
|
||||
- [ ] Bug (incorrect behavior)
|
||||
- [ ] Triggering
|
||||
- [ ] Relevancy
|
||||
- [ ] Internal (issue with code)
|
||||
- [ ] Feature Request
|
||||
- [ ] Triggers (new triggers)
|
||||
- [ ] Design Change
|
||||
|
||||
|
||||
## Description
|
||||
<!-- Describe the bug, or suggestion in detail -->
|
||||
### Description
|
||||
<!-- Describe the bug or suggestion in detail -->
|
||||
|
||||
|
||||
## Steps to recreate
|
||||
|
|
@ -33,8 +21,21 @@
|
|||
## People to notify
|
||||
<!-- Please @mention any relevant people/organizations here:-->
|
||||
|
||||
<!-- LANGUAGE LEADERS ONLY: REMOVE THIS LINE
|
||||
## Get Started
|
||||
- [ ] 1) Claim this issue by commenting below
|
||||
- [ ] 2) Review our [Contributing Guide](https://github.com/duckduckgo/zeroclickinfo-goodies/blob/master/CONTRIBUTING.md)
|
||||
- [ ] 3) [Set up your development environment](https://docs.duckduckhack.com/welcome/setup-dev-environment.html), and fork this repository
|
||||
- [ ] 4) Create a Pull Request
|
||||
|
||||
## Resources
|
||||
- Join [DuckDuckHack Slack](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 [DuckDuckHack Documentation](https://docs.duckduckhack.com/) for technical help
|
||||
|
||||
<!-- DO NOT REMOVE -->
|
||||
---
|
||||
|
||||
<!-- The Instant Answer ID can be found by clicking the `?` icon beside the Instant Answer result on DuckDuckGo.com -->
|
||||
Instant Answer Page: https://duck.co/ia/view/{ID}
|
||||
<!-- FILL THIS IN: ^^^^ -->
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<!-- Place and 'X' in the correct box (E.g `[X] Improvement`) -->
|
||||
|
||||
- [ ] 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
|
||||
<!-- What does this new Instant Answer do? What changes does this PR introduce? -->
|
||||
|
||||
|
|
@ -32,16 +20,11 @@
|
|||
|
||||
|
||||
## People to notify
|
||||
<!-- Please @mention any relevant people/organizations here:-->
|
||||
|
||||
<!-- Please @mention any relevant people/organizations here: -->
|
||||
|
||||
<!-- DO NOT REMOVE -->
|
||||
---
|
||||
|
||||
<!-- The Instant Answer ID can be found by clicking the `?` icon beside the Instant Answer result on DuckDuckGo.com -->
|
||||
|
||||
IA Page: https://duck.co/ia/view/{ID}
|
||||
|
||||
|
||||
<!-- For Instant Answers related to a forum topic -->
|
||||
|
||||
Forum Topic:
|
||||
Instant Answer Page: https://duck.co/ia/view/{ID}
|
||||
<!-- FILL THIS IN: ^^^^ -->
|
||||
|
|
|
|||
37
README.md
37
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.
|
||||
|
||||
[](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies)
|
||||
|
||||
|
||||
### 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...
|
||||
|
||||
### 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...
|
||||
|
||||
#### 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)
|
||||
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
|
|
|
|||
Loading…
Reference in New Issue