Skip to content

Latest commit

 

History

History
32 lines (16 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

32 lines (16 loc) · 2.71 KB
Raw

Contributing an Instant Answer to DuckDuckGo.com

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.

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. 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!

Your help and expertise can have a huge impact on improving the search experience for developers and DuckDuckGo users around the world!

Formatting Your Pull Request

When submitting a pull request, the following guidelines help speed up the review process:

New Instant Answers

  1. New IAs should be titled as follows: New {IA TOPIC} {IA TYPE}. For example, New Instagram Spice or New Firefox Cheat Sheet

  2. Paste the relevant Instant Answer Page URL in the description field. This will automatically link the PR to the Instant Answer.

Improvements

  1. Fixes should be titled as follows: {IA NAME}: Brief explanation. For example: PeopleInSpace: Use smaller local image, fallback to API when needed.

  2. Paste the relevant Instant Answer Page URL in the description field. This will automatically link the PR to the Instant Answer.

  3. Include the issue number in the description (conveniently, this will automatically resolve the issue upon merging). Describe your motivation, thought process, and solution in the description. For example:

    "Fixes #2038. The images used by the API are very large and don't change often. I've put a smaller version of each image (and a 2x version for retina screens) in the share directory. The callback will try and load a local image based on the astronauts name and fallback to using the API's image if one does not exist."

IMPORTANT: Don't worry if you get an initial error regarding failing Travis tests. The reason is that your IA page hasn't yet been moved out of the "Planning" status - which only community leaders/staff can do. As long as the ID in your IA page matches the ID in your code, and you've pasted the URL to your IA page, you can ignore this initial error.