Skip to content

Commit 13e7b53

Browse files
committed
2 parents 99f6d0b + 2a21242 commit 13e7b53

File tree

5 files changed

+66
-1
lines changed

5 files changed

+66
-1
lines changed

.github/issue_template.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Expected Behavior
2+
3+
### Actual Behavior
4+
5+
### Steps to Reproduce the Behavior
6+
7+
### Additional Comments

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to ArcAds
2+
3+
Welcome to the contribution guide for ArcAds. Here are some important resources to get you started:
4+
5+
* [ArcAds Wiki](https://github.com/washingtonpost/ArcAds/wiki)
6+
* [Doubleclick for Publishers](http://www.google.com/dfp)
7+
* [Prebid.js](http://prebid.org/)
8+
* [Amazon A9](https://www.a9.com/)
9+
10+
## Questions or Issues
11+
If you have a general question or an issue please refer to our FAQ which we'll update reguarly with questions. If you can't find an answer to your question please open an [issue](https://github.com/washingtonpost/ArcAds/issues).
12+
13+
## Testing
14+
ArcAds has a series of unit tests built with [Jest](https://facebook.github.io/jest/). We are always looking to improve our testing coverage , and request that if you create new functionality that you also include tests along with it.
15+
16+
## Submitting changes
17+
Please send a [Pull Request to ArcAds](https://github.com/opengovernment/opengovernment/pull/new/master) with a clear list of what you've done changed (you read more about [pull requests here](http://help.github.com/pull-requests/)).
18+
Please follow best practices guide below and make sure all of your commits are atomic (one feature per commit).
19+
20+
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
21+
22+
$ git commit -m "A brief summary of the commit
23+
>
24+
> A paragraph describing what changed and its impact."
25+
26+
## Best Practices
27+
28+
* ArcAds gets linted with the [airbnb style guide](https://github.com/airbnb/javascript).
29+
* Code should be documented and commented using the [ESDoc](https://esdoc.org/) conventions.
30+
* Please make sure you've tested your code prior to submitting a pull request and ensure everything works.
31+
32+

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 The Washington Post
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# ArcAds
2+
[![CircleCI](https://circleci.com/gh/washingtonpost/ArcAds.svg?style=shield)](https://circleci.com/gh/washingtonpost/ArcAds)
3+
24
ArcAds is a [DFP](https://www.google.com/dfp) wrapper created by [Arc Publishing](https://www.arcpublishing.com/) with publishers in mind, using ArcAds you can selectivley make use of many Google Publisher Tag (GPT) features such as size mapping, refreshing, and slot targeting. In addition you can also make use of a series of header bidding vendors such as [Prebid.js](http://prebid.org/) and [Amazon A9/TAM](https://www.a9.com/) by passing in some optional parameters.
35

46
## Getting Started
@@ -402,3 +404,6 @@ There's a series developer tools availble, to get started run `yarn install`.
402404
You can override the slot name of every advertisement on the page by appending `?adslot=` to the URL. This will override whatever is placed inside of the `slotName` field when invoking the `registerAd` method. For example if you hit the URL `arcpublishing.com/?adslot=homepage/myad`, the full ad slot path will end up being your DFP id followed by the value: `123/homepage/myad`.
403405

404406
You can also debug slot names and GPT in general by typing `window.googletag.openConsole()` into the browsers developer console.
407+
408+
## Contributing
409+
If you'd like to contribute to ArcAds please read our [contributing guide](https://github.com/washingtonpost/ArcAds/blob/master/CONTRIBUTING.md).

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"hb"
2626
],
2727
"author": "James Ives",
28-
"license": "ISC",
28+
"license": "MIT",
2929
"bugs": {
3030
"url": "https://github.com/washingtonpost/arcads/issues"
3131
},

0 commit comments

Comments
 (0)