Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Edit `pull-requests.md` and `reviewable-prs.md`. 

Fixes a few typos / errors in commit a633890d8 that updated
these documentation articles on pull requests.

Also adjusts language around screenshots to match what we use
in the pull request template on GitHub for the zulip server and
web app repository.
This commit is contained in:
Lauryn Menard 2023-03-13 15:14:06 +01:00 committed by Tim Abbott
parent 19ae2f9180
commit b9dd109e93
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/contributing/reviewable-prs.md
View File

@ -82,7 +82,7 @@ helpful for writing clear and thorough pull request comments:
- For [screenshots or screencasts][screenshots-gifs] of changes, - For [screenshots or screencasts][screenshots-gifs] of changes,
putting them in details/summary tags reduces visual clutter putting them in details/summary tags reduces visual clutter
and scroll length of pull request comments. This is especially and scroll length of pull request comments. This is especially
useful when you have various screenshots and/or screencasts to useful when you have several screenshots and/or screencasts to
include in your comment as you can put each image, or group of include in your comment as you can put each image, or group of
images, in separate details/summary tags. images, in separate details/summary tags.
@ -96,8 +96,8 @@ helpful for writing clear and thorough pull request comments:
- For before and after images or videos of changes, using GithHub's table - For before and after images or videos of changes, using GithHub's table
syntax renders them side-by-side for quick and clear comparison. syntax renders them side-by-side for quick and clear comparison.
While this this works well for narrow or small images, it can be hard While this works well for narrow or small images, it can be hard to
to see details in large, full screen images and videos in this format. see details in large, full screen images and videos in this format.
Note that you can put the table syntax inside the details/summary Note that you can put the table syntax inside the details/summary
tags described above as well. tags described above as well.

10
docs/git/pull-requests.md
View File

@ -116,17 +116,17 @@ branch to your fork, you will see a **Compare & pull request** button.
A pull request template will open with some information pre-filled in. A pull request template will open with some information pre-filled in.
Provide (or update) the title for your pull request and write a first comment. Provide (or update) the title for your pull request and write a first comment.
If your pull request has an effect on the visuals of a component, you will want If your pull request makes UI changes, always include one or more still
to include a screenshot of this change or a GIF/screencast of the interaction in screenshots to demonstrate your changes. If it seems helpful, add a screen
your first comment. You can find a list of tools you can use for this capture of the new functionality as well. You can find a list of tools you can
[here][screenshots-gifs]. use for this [here][screenshots-gifs].
See the documentation for creating [reviewable pull requests][reviewable-prs] See the documentation for creating [reviewable pull requests][reviewable-prs]
for more guidance and tips when writing pull request comments. If the repository for more guidance and tips when writing pull request comments. If the repository
has a self-review checklist in the pull request template, make sure that all the has a self-review checklist in the pull request template, make sure that all the
relevant points have been addressed before submitting it. relevant points have been addressed before submitting it.
When ready, click the **Create pull request** to submit the pull request. When ready, click the **Create pull request** button to submit the pull request.
Remember to mark your pull request as a [draft][github-help-draft-pr] if it is a Remember to mark your pull request as a [draft][github-help-draft-pr] if it is a
work-in-progress. work-in-progress.