Markdown | 74 lines | 48 code | 26 blank | 0 comment | 0 complexity | 9d107bd15a87da5ae517ae6cd0fc5bc4 MD5 | raw file
1Please use this template as a starting point for any CONTRIBUTING.md's. Make sure to replace **"\<repo\_name\>"** with the correct repository name. 2 3------ 4 5# Contributing to the **\<repo\_name\>** repository 6 7At 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. 8 9## Getting Started 10 11Before 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. 12 13## Submitting a **Bug** or **Suggestion** 14 15- Firstly, please make sure the bug is related to the **\<repo\_name\>** 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). 16 17- Check the **\<repo\_name\>** [issues](#link-to-issues) to see if an issue already exists for the given bug or suggestion 18 - If one doesn't exist, create a GitHub issue in the **\<repo\_name\>** repository 19 - Clearly describe the bug/improvement, including steps to reproduce when it is a bug 20 - If one already exists, please add any additional comments you have regarding the matter 21 22If you're submitting a **pull request** (bugfix/addition): 23- Fork the **\<repo\_name\>** repository on GitHub 24 25## Making Changes 26 27- 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 28- Make sure your commits are of a reasonable size. They shouldn't be too big (or too small) 29- Make sure your commit messages effectively explain what changes have been made, and please identify which instant answer or file has been modified: 30 31 ```shell 32 CONTRIBUTING.md - Added the example commit message because it was missing 33 ``` 34 35 is much better than: 36 37 ```shell 38 <bad_commit_example> 39 ``` 40 41- Make sure you have added the necessary tests for your changes 42- Run `dzil test` (executes all tests in t/) to ensure nothing else was accidentally broken 43- If your change affects an instant answer, remember to add yourself to the Metadata attribution list in the appropriate `.pm` file 44 45## Submitting Changes 46 471. Commit your changes. 48 49 ```shell 50 git commit -a -m "My first instant answer that does X is ready to go!" 51 ``` 52 532. Get your commit history [how you like it](http://book.git-scm.com/4_interactive_rebasing.html). 54 55 ```shell 56 git rebase -i origin/master 57 ``` 58 59 or 60 61 ```shell 62 git pull --rebase origin/master 63 ``` 64 653. Push your forked repository back to GitHub. 66 67 ```shell 68 git push 69 ``` 70 714. 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! 72Check out the [Metadata documentation](https://dukgo.com/duckduckhack/metadata) for detailed instructions on how to include your name and links. 73 745. Go into GitHub and submit a [pull request!](http://help.github.com/send-pull-requests/) to the **\<repo\_name\>** repository, making sure to use the **\<repo\_name\>** repository's **[Pull Request Template](#link-to-file)**. This will let us know about your changes and start the conversation about integrating it into the live code.