Integrate Document Guardian in Slack
Improve your code review processes with the Document Guardian integration!
What is Document Guardian about?
Document Guardian reminds you to update your documentation as you change your code. Document Guardian is a Code review application available in the GitHub marketplace.
Receive Document Guardian in Slack
Stop checking your email or your GitHub notifications. Axolo sends the notifications from Document Guardian in the corresponding pull request channel in Slack.
Document Guardian integration with Axolo
Axolo is a productivity app for engineering teams. We open one ephemeral channel for each of your pull request in order to improve engineers collaboration during code reviews.
What are Document Guardian features in GitHub?
Document Guardian: Keeping Documentation Inline with Code Document Guardian reminds you to update your documentation when you make changes to critical lines of code by leaving a comment on Pull Requests that modify that line/function. Compatible with any language! In python, you can add the phrase to your docstring instead of an inline comment! Click here for an example of behavior. Example of Use For example, imagine you had the following python function: import random def get_random_number(): """ Generates a random number between 0 and 9, inclusive. < Document Guardian | Protect > """ return random.randint(0, 9) Then, if we were to make a change to the protected line, such as the below change, we'd get a reminder on the PR. import random def get_random_number(a=0, b=26): """ Generates a random number between 0 and 25, inclusive. < Document Guardian | Protect > """ return random.randint(a, b) For an example of what the PR comment looks like, see hbrooks/dg_public_test_repo/pull/4. Frequently Asked Questions Can Document Guardian be used with any language? Yes, you just need to be able to put the Protection Phrase on the line you wish to protect.
Learn more about Document Guardian on the GitHub marketplace.