REPO: Update pr/readme template (#4474)
* Update PR template. * Update readme. * Update PULL_REQUEST_TEMPLATE.md * Update README.mdmaster
PJ Hampton
Zaahir Moolla
parent
687f7de9f2
commit
df205e2335
|
|
@ -1,17 +1,16 @@
|
||||||
<!-- Use the appropriate format for your Pull Request title above ^^^^^:
|
<!--
|
||||||
|
|
||||||
|
***
|
||||||
|
DuckDuckHack is currently in Maintenance mode
|
||||||
|
Please read before submitting: https://duckduckhack.com
|
||||||
|
***
|
||||||
|
|
||||||
|
Use the following format for your Pull Request title above ^^^^^:
|
||||||
|
|
||||||
If this is a bug fix:
|
|
||||||
{IA Name}: {Description of change}
|
{IA Name}: {Description of change}
|
||||||
|
|
||||||
If this is a New Instant Answer:
|
|
||||||
New {IA Name} Goodie
|
|
||||||
|
|
||||||
If this is something else:
|
|
||||||
{Tests/Docs/Other}: {Short Description}
|
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
||||||
## Description of new Instant Answer, or changes
|
## Description of new Instant Answer, or changes
|
||||||
<!-- What does this new Instant Answer do? What changes does this PR introduce? -->
|
<!-- What does this new Instant Answer do? What changes does this PR introduce? -->
|
||||||
|
|
||||||
|
|
@ -25,38 +24,6 @@ If this is something else:
|
||||||
<!-- Please @mention any relevant people/organizations here: -->
|
<!-- Please @mention any relevant people/organizations here: -->
|
||||||
|
|
||||||
|
|
||||||
## 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 <goodie_id>`)
|
|
||||||
- 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
|
|
||||||
|
|
||||||
<!-- DO NOT REMOVE -->
|
<!-- DO NOT REMOVE -->
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
31
README.md
31
README.md
|
|
@ -1,27 +1,16 @@
|
||||||
[](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies)
|
# In Maintenance
|
||||||
|
|
||||||
# Welcome to DuckDuckHack!
|
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).
|
||||||
We're a community of open source developers from around the world, contributing code to improve the DuckDuckGo search engine.
|
|
||||||
|
|
||||||
|
## What are essential bug fixes?
|
||||||
|
|
||||||
## How to contribute
|
Any changes necessary to keep existing Instant Answers functioning correctly and as expected. For example:
|
||||||
- [**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!
|
|
||||||
|
|
||||||
|
- 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?
|
Any other changes will not be accepted. For example:
|
||||||
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.
|
|
||||||
|
|
||||||
#### Example: JavaScript Minifier Goodie
|
- spelling/comment changes
|
||||||
- [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)
|
- unsolicited improvements, changes, and code refactoring
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue