diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c4b2894b7..4ab79f038 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,16 @@ - - ## Description of new Instant Answer, or changes @@ -25,38 +24,6 @@ If this is something else: -## Testing & Review -To be completed by Community Leader (or DDG Staff) when reviewing Pull Request - -**Pull Request** -- [ ] Title follows correct format (Specifies Instant Answer + Purpose) -- [ ] Description contains a valid Instant Answer Page Link (e.g. https://duck.co/ia/view/my_ia) - -**Instant Answer Page** (for new Instant Answers) -- [ ] Instant Answer page is correctly filled out and contains: - - The **Title** is appropriately named and formatted - - The **IA topics** are present and appropriate - - The **Description** is clear and coherent - - **Source Name** exists if applicable - - All **Example Queries** trigger on [Beta](https://beta.duckduckgo.com/) - -**Code** -- [ ] Adheres to the [DuckDuckGo Style Guide](https://docs.duckduckhack.com/resources/code-style-guide.html) -- [ ] Behaviour is appropriately tested. If improvement, tests are adequately extended. -- [ ] There is no unnecessary files in place (such as editor config files) -- [ ] There is no API keys / secrets present -- [ ] Tests are passing (run `$ duckpan test `) - - Tester should report any failures - -**Ready to merge?** - -- [ ] Has this IA been deployed to and tested on [beta.duckduckgo.com](https://beta.duckduckgo.com/)? -- [ ] For larger commits, has this been approved be more than one community member? -- [ ] The number of reviews is appropriate for this type of PR -- [ ] The commit message is clear, coherent and fitting - -**Pull Request Review Guidelines**: https://docs.duckduckhack.com/testing-reference/pr-review.html - --- diff --git a/README.md b/README.md index 79c990e7e..fe28f004d 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,16 @@ -[![Build Status](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies.svg?branch=master)](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies) +# In Maintenance -# Welcome to DuckDuckHack! -We're a community of open source developers from around the world, contributing code to improve the DuckDuckGo search engine. +DuckDuckHack is now in maintenance mode. We are only accepting pull requests for essential bug fixes. For more information see [duckduckhack.com](https://duckduckhack.com). +## What are essential bug fixes? -## How to contribute -- [**Create new Goodie Instant Answers, and improve existing ones**](https://duckduckhack.com/issues) - - **Note**: Goodies are written in Perl (back-end) and JavaScript (front-end). They can also typically use CSS, and [Handlebars](http://handlebarsjs.com) Templates. -- [**Visit DuckDuckHack**](https://duckduckhack.com/#get-help) to learn more about how you can help! -- [**Read the DuckDuckHack Docs**](https://docs.duckduckhack.com/) to learn how to set up a development environment and start contributing! +Any changes necessary to keep existing Instant Answers functioning correctly and as expected. For example: + - Updating the URL for a Spice Instant Answer when the API changes + - Correcting a Perl or JavaScript logic error + - Fixing CSS that's causing the display to break -### What are Goodie Instant Answers? -Goodies do not retrieve data from a third party API. Goodies provide their results entirely through server-side code. They may use a static data file stored on DuckDuckGo's server, but they do not call external resources. +Any other changes will not be accepted. For example: -#### Example: JavaScript Minifier Goodie -- [Code](https://github.com/duckduckgo/zeroclickinfo-goodies/blob/master/lib/DDG/Goodie/JsMinify.pm) | [Example Query](https://duckduckgo.com/?q=js+minifier&ia=answer) | [Instant Answer Page](https://duck.co/ia/view/js_minify) - -![javascript minifier search](https://cloud.githubusercontent.com/assets/873785/20068349/626d9036-a4e6-11e6-945b-790bae2d2cdc.png) - - -## Resources -- Join the [DuckDuckHack Slack channel](https://quackslack.herokuapp.com/) to ask questions -- Join the [DuckDuckHack Forum](https://forum.duckduckhack.com/) to discuss project planning and Instant Answer metrics -- Read the [Goodie documentation](https://docs.duckduckhack.com/walkthroughs/calculation.html) for technical help -- View the list of [all live Goodie Instant Answers](https://duck.co/ia?repo=goodies&topic=programming) to see more examples + - spelling/comment changes + - unsolicited improvements, changes, and code refactoring