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

Latest commit

 

History

History
61 lines (41 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.87 KB
Raw

Contributing to ZeroClickInfo-Spice

At DuckDuckGo, we truly appreciate our community members taking the time to contribute to our open-source repositores. 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

If submitting a bug or suggestion:

  • Check the ZeroClickInfo-Spice 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 ZeroClickInfo-Spice repository
      • Clearly describe the bug/improvemnt, including steps to reproduce when it is a bug
    • If one already exists, please add any aditional comments you have regarding the matter

If submitting a pull request (bugfix/addition):

  • Fork the ZeroClickInfo-Spice repository on GitHub

Making Changes

  • Before making and changes, refer to the ZeroClickInfo Plugin Guidelines to assure 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 plugin or file has been modified:

    AlternativeTo - removed CSS file, fixed <li> height in Spice.render()

    is much better than:

    fixed AlternativeTo plugin

  • Make sure you have added the necessary tests for your changes. Consider all edge cases and make sure they are handled correctly

    • Examples can be found in the t/ directory
    • Exhasutive tests are always appreciated!

  • Run dzil test (executes all tests in t/) to ensure nothing else was accidentally broken

Submitting Changes

Step 1. Commit your changes.

git commit -a -m "My first plugin that does X is ready to go!"

Step 2. Get your commit history how you like it.

git rebase -i origin/master

Step 3. Push your forked repository back to GitHub.

git push

Step 4. Add your info to the plugin 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 README for detailed instructions on how to include your name and links.

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