zeroclickinfo-goodies/CONTRIBUTING.md

61 lines
3.6 KiB
Markdown
Raw Normal View History

2015-07-07 14:34:16 -07:00
# Contribute to Goodie Instant Answers
2015-07-07 14:34:16 -07:00
There are several options for contributing Goodie Instant Answers, explained below.
2015-07-07 14:34:16 -07:00
You can always find the [Instant Answer Documentation here](https://duck.co/duckduckhack/ddh-intro). Also, if you have any questions at any point, feel free to ask on one of our community channels:
2015-07-16 11:54:30 -07:00
- [DuckDuckHack mailing list](https://www.listbox.com/subscribe/?list_id=197814)
- [Gitter chat](https://gitter.im/duckduckgo/Ideas)
2015-07-07 14:34:16 -07:00
- Do not hesitate to email us directly at [open@duckduckgo.com](mailto:open@duckduckgo.com).
## New? Make Your First Contribution Today
If this is your first time contributing to [DuckDuckHack](http://www.duckduckhack.com), you have two great ways to quickly make your first commit:
2015-07-16 11:54:30 -07:00
- **Make a [Cheat Sheet](https://duck.co/duckduckhack/goodie_cheat_sheets)**
2015-07-16 11:54:30 -07:00
Cheat sheets are a super-easy way to contribute to the live DuckDuckGo AnswerBar very quickly, by editing a single file. Cheat sheets can be about anything, from Emacs and Vim to Game of Thrones house names or wine pairings.
2015-07-16 11:54:30 -07:00
- **Create a simple, complete "Hello World" Goodie with our [Quick Start Tutorial](https://duck.co/duckduckhack/goodie_quickstart)**
2015-07-16 11:54:30 -07:00
This short tutorial will lead you through all the parts of building a full-loop Goodie. This is a perfect place to start if you have an idea for an original Instant Answer.
2015-07-07 14:34:16 -07:00
## Create a New Instant Answer
2015-07-09 12:59:14 -07:00
Once you're comfortable with the workflow and how Goodies work, we're excited to have you create your own original Instant Answer.
2015-07-09 12:53:03 -07:00
**1. Choose an idea**
2015-07-09 12:54:22 -07:00
Bring your own idea, or check out the ideas forum - especially [top voted answer ideas](https://duck.co/ideas/status/3?table_lnKRpLENwO2NUmZUyukQpw_sort=votes).
2015-07-09 12:53:03 -07:00
**2. Plan your implementation**
2015-07-09 12:54:22 -07:00
The first step is to research and plan your Instant Answer. Consider [the best way to implement](https://duck.co/duckduckhack/determine_your_instant_answer_type) your idea, and review the [docs and guidelines](https://duck.co/duckduckhack/ddh-intro) that apply.
2015-07-07 14:34:16 -07:00
2015-07-09 12:53:03 -07:00
**3. Involve us**
2015-07-09 12:54:22 -07:00
Before you start coding, [let us know your plans](mailto:open@duckduckgo.com). By involving us early we can provide guidance and potentially save you a lot of time and effort. Email us at [open@duckduckgo.com](mailto:open@duckduckgo.com) with what idea you're working on and how you're thinking of going about it.
2015-07-09 12:54:22 -07:00
In addition, we'll promptly set up a [central Instant Answer page](http://www.duck.co/ia) on the community platform so others can know you're working on it and how they can help you.
2015-07-07 14:34:16 -07:00
## Improve an Existing Instant Answer
2015-07-09 12:59:14 -07:00
Another great way to contribute is to improve an existing, live Instant Answer. It's a great way to get further acquainted with Instant Answers, as well as get implementation ideas. (Many contributors report completing their first fix within two hours of forking the repository!)
2015-07-07 14:34:16 -07:00
2015-07-09 12:53:03 -07:00
**1. Choose a "low-hanging fruit"**
2015-07-07 14:34:16 -07:00
2015-07-09 12:54:22 -07:00
We've made sure to identify these throughout our repositories for new contributors.
2015-07-07 14:34:16 -07:00
2015-07-09 12:54:22 -07:00
- [Goodie Low Hanging Fruit](https://github.com/duckduckgo/zeroclickinfo-goodies/issues?q=is%3Aopen+is%3Aissue+label%3A%22Low-Hanging+Fruit%22) ([Goodie docs](https://duck.co/duckduckhack/goodie_overview))
- [Spice Low Hanging Fruit](https://github.com/duckduckgo/zeroclickinfo-spice/issues?q=is%3Aopen+is%3Aissue+label%3A%22Low-Hanging+Fruit%22) ([Spice docs](https://duck.co/duckduckhack/spice_overview))
2015-07-09 12:53:03 -07:00
**2. Dive in**
2015-07-09 12:59:14 -07:00
Go ahead and comment on any issues you're interested in helping with. Let us know what you're thinking and if you'd like any help or guidance.
2015-07-07 14:34:16 -07:00
2015-07-09 12:54:22 -07:00
As always, feel free to [ask us anything](mailto:open@duckduckgo.com), and don't forget the handy [Instant Answer documentation](https://duck.co/duckduckhack/ddh-intro).