Why CDOC?
User Manual
Development
Github
LOGO
Why CDOC?
User Manual
Development
Github
Pull Request Description
In Github PRs, there is an area which includes the description of the Pull Request:
Upto-date
Missing
This document is not yet translated to ⁨English⁩. You are seeing ⁨English⁩ version.
Never Marked
The translation of this document is not yet approved.
Show unapproved version
Out-dated
The ⁨English⁩ document was last modified on ⁨Never Synced⁩. Since then, the ⁨English⁩ version has the following changes.
This document is out dated.
Show latest version
View changes
The following changes has been made in English edition since last modification


Pull Request Description

The content of the description is editable using the Github’s Update a pull request API, using the body field mentioned there.

We will append our UI at the bottom of the PR description. Since the description will change over time, we will put a marker in the PR description body, and anything after that marker would be assumed to be our content, and we would keep overwriting the content.

This can cause two race conditions, which if we can not mitigate we will not use pull request description approach, and fall back to last comment approach.

Why CDOC?
User Manual
Development
Github
Table of contents:
Flow
Permissions
Three Approvals
Github UI
PR Description
Race Condition
Last Comment UI
PR States
Pages
PR Page
Repo Page
ftd Page
LOGO
Why CDOC?
User Manual
Development
Github
Pull Request Description
In Github PRs, there is an area which includes the description of the Pull Request:
Upto-date
Missing
This document is not yet translated to ⁨English⁩. You are seeing ⁨English⁩ version.
Never Marked
The translation of this document is not yet approved.
Show unapproved version
Out-dated
The ⁨English⁩ document was last modified on ⁨Never Synced⁩. Since then, the ⁨English⁩ version has the following changes.
This document is out dated.
Show latest version
View changes
The following changes has been made in English edition since last modification