Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 3.68 KB
Raw

Contributing to Goodie

At 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.

Getting Started

Before you can do anything, you first need a GitHub account. 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.

Submitting a Bug or Suggestion

  • 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).

  • Check the Goodie 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 Goodie 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 Goodie repository on GitHub

Making Changes

  • Before making any changes, refer to the DuckDuckHack Styleguide 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:

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

    is much better than:

    <bad_commit_example>

  • Make sure you have added the necessary tests for your changes

    • When modifying the triggers, update existing tests and add some new tests to show it works as expected
    • When modifying the result, update existing tests accordingly

  • 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.
git commit -a -m "My first instant answer that does X is ready to go!"
  1. Get your commit history how you like it.
git rebase -i origin/master

or

git pull --rebase origin/master
  1. Push your forked repository back to GitHub.
git push

  1. Add your info to the instant answer so we can give you credit for it on the Goodies page. You'll see your name or handle on the live site! Check out the Metadata documentation for detailed instructions on how to include your name and links.

  2. Go into GitHub and submit a pull request! to the Goodie repository, making sure to use the Goodie repository's Pull Request Template. This will let us know about your changes and start the conversation about integrating it into the live code.