tommasop / 0pdd

PDD Puzzles Collector

What does it do?

Read this blog post first: PDD in Action

0pdd.com is a hosted service that finds new "puzzles" in your repository and posts them as GitHub issues. To start using it just create a Webhook in your repository just for push events with http://www.0pdd.com/hook/github payload URL and application/json content type.

Then, add @0pdd GitHub user as a collaborator with read-only access to your repository.

Then, add a @todo puzzle to the source code (format it right).

Then, git push something and see what happens. You should see a new issue created in your repository by @0pdd.

Don't forget to add that cute little badge to your README.md, just like we did here in this repo (see above). The Markdown you need will look like this (replace yegor256/0pdd with GitHub coordinates of your own repository):

[![PDD status](http://www.0pdd.com/svg?name=yegor256/0pdd)](http://www.0pdd.com/p?name=yegor256/0pdd)

How to configure?

The only way to configure 0pdd is to add .0pdd.yml file to the root directory of your master branch (see this one as a live example). It has to be a YAML file with the following optional parameters inside:

errors:
  - [e-mail]
alerts:
  github:
    - yegor256

Section errors allows you to specify a list of email addresses which will receive notifications when PDD processing fails for your repo. It's a very useful feature, since very often programmers make mistakes in PDD puzzle formatting. We would recommend you use this feature.

Section alerts allows you to specify users that will be notified when new PDD puzzles show us. By default we will just submit GitHub tickets and that's it. If you add github subsection there, you can list GitHub users who will be notified.

pdd is the tool that parses your source code files. You can configure its behavior by adding .pdd file to the root directory of the repository. Take this one, as an example.

How to contribute?

Just submit a pull request. Make sure rake passes.

How to install in Heroku

Don't forget this:

heroku buildpacks:add --index 1 https://github.com/heroku/heroku-buildpack-apt

License

(The MIT License)

Copyright (c) 2016-2017 Yegor Bugayenko

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.