Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.98 KB

Contributing

We are excited that you want to help make DuckDuckGo Search & Stories better. Some of the best features of DuckDuckGo came from the community!

  • If there isn't already an open issue that describes your bug or feature, please submit one.
    • If you're submitting a bug, please describe a way we can reproduce the problem and the affected versions.
    • If you're submitting a feature (cool!), make sure you contact us beforehand so that you aren't duplicating effort.

Changes

  • Bugs fork the repository on GitHub and create a topic branch from master with your GitHub username in the branch name like: git checkout -b nilnilnil/segfault-stories-swipe origin/master
  • Features fork the repository on GitHub and create a topic branch from develop with your GitHub username in the branch name like: git checkout -b nilnilnil/sooper-feature origin/develop
  • Add tests that check what you've done.
  • PRs with failing tests will not be accepted.

Commit format:

    (#GH_ISSUE) Make the example in CONTRIBUTING imperative and concrete.

    Without this patch applied the example commit message in the CONTRIBUTING
    document is not a concrete example.  This is a problem because the
    contributor is left to imagine what the commit message should look like
    based on a description rather than an example.  This patch fixes the
    problem by making the example concrete and imperative.

    The first line is a real life imperative statement with a GitHub issue #.
    The body describes the behavior without the patch, why this is a problem,
    and how the patch fixes the problem when applied.

Additional Resources