Markdown | 70 lines | 46 code | 24 blank | 0 comment | 0 complexity | 86849e7756182a5266281b331d713f73 MD5 | raw file
1# Contributing to Goodie 2 3At DuckDuckGo, we truly appreciate our community members taking the time to contribute to our open-source repositories. In an effort to ensure contributions are easy for you to make and for us to manage, we have written some guidelines that we ask our contributors to follow so that we can handle pull requests in a timely manner with as little friction as possible. 4 5## Getting Started 6 7Before you can do anything, you first need a [GitHub account](https://github.com/signup/free). This is required because we use GitHub to handle all incoming *Pull Requests* (code modifications) and *Issues* (bug reports) which cannot be made without a GitHub account. 8 9## Submitting a **Bug** or **Suggestion** 10 11- Firstly, please make sure the bug is related to the Goodie repository. If this bug is about the DuckDuckGo API, or the relevancy of our search results, please visit our feedback page at <https://duckduckgo.com/feedback>. If you're unsure, its best to use the feedback page (your message will be passed along to the correct people). 12 13- Check the Goodie [issues](https://github.com/duckduckgo/zeroclickinfo-goodies/issues) to see if an issue already exists for the given bug or suggestion 14 - If one doesn't exist, create a GitHub issue in the Goodie repository 15 - Clearly describe the bug/improvemnt, including steps to reproduce when it is a bug 16 - If one already exists, please add any additional comments you have regarding the matter 17 18If you're submitting a **pull request** (bugfix/addition): 19- Fork the Goodie repository on GitHub 20 21## Making Changes 22 23- Before making any changes, refer to the [DuckDuckHack Styleguide](https://dukgo.com/duckduckhack/styleguide_overview) to ensure your changes are made in the correct fashion 24- Make sure your commits are of a reasonable size. They shouldn't be too big (or too small) 25- Make sure your commit messages effectively explain what changes have been made, and please identify which instant answer or file has been modified: 26 27 ```shell 28 CONTRIBUTING.md - Added the example commit message because it was missing 29 ``` 30 31 is much better than: 32 33 ```shell 34 <bad_commit_example> 35 ``` 36 37- Make sure you have added the necessary tests for your changes 38- Run `dzil test` (executes all tests in t/) to ensure nothing else was accidentally broken 39- If your change affects an instant answer, remember to add yourself to the Metadata attribution list in the appropriate `.pm` file 40 41## Submitting Changes 42 431. Commit your changes. 44 45 ```shell 46 git commit -a -m "My first instant answer that does X is ready to go!" 47 ``` 48 492. Get your commit history [how you like it](http://book.git-scm.com/4_interactive_rebasing.html). 50 51 ```shell 52 git rebase -i origin/master 53 ``` 54 55 or 56 57 ```shell 58 git pull --rebase origin/master 59 ``` 60 613. Push your forked repository back to GitHub. 62 63 ```shell 64 git push 65 ``` 66 674. Add your info to the instant answer so we can give you credit for it on the [Goodies page](https://duckduckgo.com/goodies). You'll see your name or handle on the live site! 68Check out the [Metadata documentation](https://dukgo.com/duckduckhack/metadata) for detailed instructions on how to include your name and links. 69 705. Go into GitHub and submit a [pull request!](http://help.github.com/send-pull-requests/) to the Goodie repository, making sure to use the Goodie repository's **[Pull Request Template](https://github.com/duckduckgo/zeroclickinfo-goodies/blob/master/pull_request_template_goodie.md)**. This will let us know about your changes and start the conversation about integrating it into the live code.