Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/washingtonpost/ArcAds
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesIves committed Apr 19, 2018
2 parents 99f6d0b + 2a21242 commit 13e7b53
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Expected Behavior

### Actual Behavior

### Steps to Reproduce the Behavior

### Additional Comments
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to ArcAds

Welcome to the contribution guide for ArcAds. Here are some important resources to get you started:

* [ArcAds Wiki](https://github.com/washingtonpost/ArcAds/wiki)
* [Doubleclick for Publishers](http://www.google.com/dfp)
* [Prebid.js](http://prebid.org/)
* [Amazon A9](https://www.a9.com/)

## Questions or Issues
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).

## Testing
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.

## Submitting changes
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/)).
Please follow best practices guide below and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

## Best Practices

* ArcAds gets linted with the [airbnb style guide](https://github.com/airbnb/javascript).
* Code should be documented and commented using the [ESDoc](https://esdoc.org/) conventions.
* Please make sure you've tested your code prior to submitting a pull request and ensure everything works.


21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 The Washington Post

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# ArcAds
[![CircleCI](https://circleci.com/gh/washingtonpost/ArcAds.svg?style=shield)](https://circleci.com/gh/washingtonpost/ArcAds)

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.

## Getting Started
Expand Down Expand Up @@ -402,3 +404,6 @@ There's a series developer tools availble, to get started run `yarn install`.
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`.

You can also debug slot names and GPT in general by typing `window.googletag.openConsole()` into the browsers developer console.

## Contributing
If you'd like to contribute to ArcAds please read our [contributing guide](https://github.com/washingtonpost/ArcAds/blob/master/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"hb"
],
"author": "James Ives",
"license": "ISC",
"license": "MIT",
"bugs": {
"url": "https://github.com/washingtonpost/arcads/issues"
},
Expand Down

0 comments on commit 13e7b53

Please sign in to comment.