Wiki/Reporting: update example output for gitblame reports
#24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The generation of the output examples for the `gitblame` report cannot easily be automated for the following reasons: 1. If using code samples committed to this repo, there would (for now) only be one author, making the output example not a very good example. 2. If generating these output examples from an existing codebase, there may be privacy issues in play when using the handles/names of real developers. All in all, for now, the output has been manually updated to use the current report format, but using fake data.
|
Thank you for your PR. Please review the resulting final markdown files via the created artifact. N.B.: the above link will automatically be updated when this PR is updated. |
jrfnl
added
Type: documentation consistency/QA
and removed
Type: chores/QA/automation
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The generation of the output examples for the
gitblamereport cannot easily be automated for the following reasons:All in all, for now, the output has been manually updated to use the current report format, but using fake data.