Skip to content
This repository has been archived by the owner on Oct 15, 2022. It is now read-only.

Commit

Permalink
Merge pull request #192 from DomWilliams0/master
Browse files Browse the repository at this point in the history
Fix broken links and placeholders in CONTRIBUTING.md
  • Loading branch information
zekiel committed Jun 23, 2016
2 parents 6cddeb2 + 44bb45a commit 28183ab
Showing 1 changed file with 3 additions and 51 deletions.
54 changes: 3 additions & 51 deletions CONTRIBUTING.md
Expand Up @@ -10,61 +10,13 @@ Before you can do anything, you first need a [GitHub account](https://github.com

- Firstly, please make sure the bug is related to the **DuckDuckGo** 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).

- Check the **DuckDuckGo** [issues](#link-to-issues) to see if an issue already exists for the given bug or suggestion
- Check the **DuckDuckGo** [issues](https://github.com/duckduckgo/duckduckgo/issues) to see if an issue already exists for the given bug or suggestion
- If one doesn't exist, create a GitHub issue in the **DuckDuckGo** repository
- Clearly describe the bug/improvemnt, including steps to reproduce when it is a bug
- If one already exists, please add any additional comments you have regarding the matter

If you're submitting a **pull request** (bugfix/addition):
- Fork the **DuckDuckGo** repository on GitHub

## Making Changes

- Before making any changes, refer to the [DuckDuckHack Styleguide](https://duck.co/duckduckhack/styleguide_overview) to ensure your changes are made in the correct fashion
- Make sure your commits are of a reasonable size. They shouldn't be too big (or too small)
- Make sure your commit messages effectively explain what changes have been made, and please identify which instant answer or file has been modified:

```shell
CONTRIBUTING.md - Added the example commit message because it was missing
```

is much better than:

```shell
<bad_commit_example>
```

- Make sure you have added the necessary tests for your changes
- Run `dzil test` (executes all tests in t/) to ensure nothing else was accidentally broken
- If your change affects an instant answer, remember to add yourself to the Metadata attribution list in the appropriate `.pm` file

## Submitting Changes

1. Commit your changes.

```shell
git commit -a -m "My first instant answer that does X is ready to go!"
```

2. Get your commit history [how you like it](http://schacon.github.io/gitbook/4_interactive_rebasing.html).

```shell
git rebase -i origin/master
```

or

```shell
git pull --rebase origin/master
```

3. Push your forked repository back to GitHub.

```shell
git push
```

4. 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!
Check out the [Metadata README](metadata.md) for detailed instructions on how to include your name and links.
- Find detailed instructions for adding an **Instant Answer** [here](http://docs.duckduckhack.com/submitting/pull-request.html)
- For other changes, see [this handy guide](http://docs.duckduckhack.com/resources/git-workflow.html) on submitting a pull request

5. Go into GitHub and submit a [pull request!](http://help.github.com/send-pull-requests/) to the **DuckDuckGo** repository, making sure to use the **DuckDuckGo** repository's **[Pull Request Template](https://github.com/duckduckgo/duckduckgo/blob/master/duckduckgo_pr_template.md)**. This will let us know about your changes and start the conversation about integrating it into the live code.

0 comments on commit 28183ab

Please sign in to comment.