Giter Site home page Giter Site logo

behaviorbot / update-docs Goto Github PK

View Code? Open in Web Editor NEW
32.0 5.0 9.0 101 KB

Prompts users to include documentation in pull requests

Home Page: https://github.com/apps/update-docs

License: MIT License

JavaScript 100.00%
probot probot-app github-app

update-docs's People

Contributors

carloscuesta avatar hakusaro avatar hiimbex avatar kengotoda avatar shermanhui avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

update-docs's Issues

Count Code Comments as Documentation

It would be cool if there were an optional param in the config file like updateDocsCodeComments that, if set to true, would scan code changes to see if any comments were added and count that as documentation.

Not sure the best approach for checking comments in different languages ๐Ÿค” but there may be resources out there that do this already.

Feature request: prevent merging

It would be cool if this bot could prevent merging of a PR until the docs have been updated.

Also related to this, the bot should check on subsequent commits and allow an alternate message.
e.g. Oops, you still haven't updated the docs ๐Ÿ˜‰

Is this hosted?

I installed the app, but the bot doesn't seem to be running.
Do I need to create my own app and deploy it?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.