Automatic Documentation
Last updated
Last updated
Developers usually discuss code on multiple platforms—usually GitHub and Slack. All discussions that occur outside GitHub aren't documented on the pull request itself and are essentially lost once merged.
When another developer revisits this PR in the future he will not be able to find the Slack discussions, and will potentially lose important information about discussions that led to specific code changes.
This means that most pull requests are under-documented, simply because much of the discussions occur on Slack—and that important information is being lost for future reference because of it.
devoro solves this issue by syncing back to GitHub all discussions that occur in the Slack review channel of the pull request.
Each pull request receives its own Slack channel with all collaborators invited (see Slack Review Channels). All discussions that occur on that channel are posted back to GitHub by devoro—and vice versa.
The two-way sync ensures that -
No important information about a pull request is ever lost
Pull requests are always fully documented for future reference, improving your codebase documentation
Slack review channels are always up to date with GitHub comments