Add generic contributing md page. (#4290)

Add lower part as markdown.

Update heading.

Add update.
master
PJ Hampton 2017-06-20 20:30:21 +01:00 committed by Zaahir Moolla
parent 4680490b7a
commit 999c6d86bb
1 changed files with 17 additions and 28 deletions

View File

@ -1,32 +1,21 @@
# Contributing an Instant Answer to DuckDuckGo.com
<p align="center">
<img src="https://pbs.twimg.com/profile_images/542062260600840192/nK5NSKBY_400x400.png" height="180px" width="180px" alt="ddg logo" />
</p>
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.
<p align="center">
<a href="https://duckduckhack.com/contributing.html">>> DUCKDUCKHACK CONTRIBUTING.MD <<</a>
</p>
<p align="center">This document is hosted on our community website. Please use above link or the table of contents below.</p>
**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)
## Contents
*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](https://duck.co/ia/new_ia) 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](https://duck.co/ia/new_ia) 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.
- [Our Core Values](https://duckduckhack.com/contributing.html#our-core-values)
- [Reporting Issues](https://duckduckhack.com/contributing.html#reporting-issues)
- [Making Pull Requests](https://duckduckhack.com/contributing.html#pull-requests)
- [New Instant Answers](https://duckduckhack.com/contributing.html#new-instant-answers)
- [Improvements](https://duckduckhack.com/contributing.html#improvements)
- [Not Following these guidelines?](https://duckduckhack.com/contributing.html#not-following-these-guidelines)
- [Not Sure?](https://duckduckhack.com/contributing.html#not-sure)