Skip to content

Pull Request Maps

Once a map is installed on a repository, Pull Request Maps will be automatically generated for every pull request made to the repository.

Generating A Pull Request Map

To get started, make a pull request to the repository.

Once that's done, the codesee-architecture-diagrams bot will automatically comment on your pull request with an image of a Map showing the files impacted by the PR, along with a Map legend. Below is an example from Distribute Aid's public repository:

Generated diagram showing a pull request Generated CodeSee map legend

The legend consists of three types of changes:

  • Added: Files/folders added in this pull request
  • Removed: Files/folders removed in this pull request
  • Edited: Files/folders that have been modified in this pull request

If commits are made to this pull request, a new PR diagram will be generated.