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

Commit bdb275b

Browse files
pjhamptonmoollaza
authored andcommitted
REPO: Update pr/readme template (#3418)
* Update the PR templates. * Update README. * Update PULL_REQUEST_TEMPLATE.md * Update README.md
1 parent d8c2a69 commit bdb275b

File tree

2 files changed

+19
-24
lines changed

2 files changed

+19
-24
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
<!-- Use the appropriate format for your Pull Request title above ^^^^^:
1+
<!--
2+
3+
***
4+
DuckDuckHack is currently in Maintenance mode
5+
Please read before submitting: https://duckduckhack.com
6+
***
7+
8+
Use the appropriate format for your Pull Request title above ^^^^^:
29
310
If this is a bug fix:
411
{IA Name}: {Description of change}
@@ -11,7 +18,6 @@ If this is something else:
1118
1219
-->
1320

14-
1521
## Description of new Instant Answer, or changes
1622
<!-- What does this new Instant Answer do? What changes does this PR introduce? -->
1723

@@ -24,6 +30,7 @@ If this is something else:
2430
## People to notify
2531
<!-- Please @mention any relevant people/organizations here: -->
2632

33+
2734
<!-- DO NOT REMOVE -->
2835
---
2936

Diff for: README.md

+10-22
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,16 @@
1-
[![Build Status](https://travis-ci.org/duckduckgo/zeroclickinfo-spice.svg?branch=master)](https://travis-ci.org/duckduckgo/zeroclickinfo-spice)
1+
# In Maintenance
22

3-
# Welcome to DuckDuckHack!
4-
We're a community of open source developers from around the world, contributing code to improve the DuckDuckGo search engine.
3+
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).
54

5+
## What are essential bug fixes?
66

7-
## How to contribute
8-
- [**Create new Spice Instant Answers, and improve existing ones**](https://duckduckhack.com/issues)
9-
- **Note**: Spices are written in Perl (back-end) and JavaScript (front-end). They can also typically use CSS, and [Handlebars](http://handlebarsjs.com) Templates.
10-
- [**Visit DuckDuckHack**](https://duckduckhack.com/#get-help) to learn more about how you can help!
11-
- [**Read the DuckDuckHack Docs**](https://docs.duckduckhack.com/) to learn how to set up a development environment and start contributing!
7+
Any changes necessary to keep existing Instant Answers functioning correctly and as expected. For example:
128

9+
- Updating the URL for a Spice Instant Answer when the API changes
10+
- Correcting a Perl or JavaScript logic error
11+
- Fixing CSS that's causing the display to break
1312

14-
### What are Spice Instant Answers?
15-
Spices retrieve data from third-party JSON APIs. An API call is generated at the time of the query, and the JSON data returned is used to build an Instant Answer result on the front-end.
13+
Any other changes will not be accepted. For example:
1614

17-
18-
#### Example: NPM Spice
19-
- [Code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/lib/DDG/Spice/Npm.pm) | [Example Query](https://duckduckgo.com/?q=npm+express.js&t=opera&ia=software) | [Instant Answer Page](https://duck.co/ia/view/npm)
20-
21-
![npm expressjs search](https://cloud.githubusercontent.com/assets/873785/20064623/515e8b04-a4d9-11e6-84d9-66ffa2a5d6d2.png)
22-
23-
24-
## Resources
25-
- Join the [DuckDuckHack Slack channel](https://quackslack.herokuapp.com/) to ask questions
26-
- Join the [DuckDuckHack Forum](https://forum.duckduckhack.com/) to discuss project planning and Instant Answer metrics
27-
- Read the [Spice documentation](https://docs.duckduckhack.com/walkthroughs/forum-lookup.html) for technical help
28-
- View the list of [all live Spice Instant Answers](https://duck.co/ia?repo=spice&topic=programming) to see more examples
15+
- spelling/comment changes
16+
- unsolicited improvements, changes, and code refactoring

0 commit comments

Comments
 (0)