behaviorbot / update-docs Goto Github PK
View Code? Open in Web Editor NEWPrompts users to include documentation in pull requests
Home Page: https://github.com/apps/update-docs
License: MIT License
Prompts users to include documentation in pull requests
Home Page: https://github.com/apps/update-docs
License: MIT License
The procedure for doing this is laid out more thoroughly here: behaviorbot/sentiment-bot#13.
Let me know if you have any questions!
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.
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 ๐
I installed the app, but the bot doesn't seem to be running.
Do I need to create my own app and deploy it?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.