diff --git a/docs/git-guide.md b/docs/git-guide.md index 98de272830..2c0e610314 100644 --- a/docs/git-guide.md +++ b/docs/git-guide.md @@ -898,7 +898,13 @@ You'll see the *Open a pull request* page: ![images-create-pr] Provide a **title** and first comment for your pull request. Remember to prefix -your pull request title with [WIP] if it is a work-in-progress. +your pull request title with [WIP] if it is a work-in-progress. + +If your pull request has an effect on the visuals of a component, you might want +to include a screenshot of this change or a GIF of the interaction in your first +comment. This will allow reviewers to comment on your changes without having to +checkout your branch; you can find a list of tools you can use for this over +[here][screenshots-gifs]. When ready, click the green **Create pull request** to submit the pull request. @@ -1481,6 +1487,7 @@ Deleting local branch review-original-5156 (was 5a1e982) [gitgui-gitk]: https://git-scm.com/docs/gitk [travis-ci]: https://travis-ci.org/ [travis-ci-profile]: https://travis-ci.org/profile +[screenshots-gifs]: screenshot-and-gif-software.html [self-setup]: git-guide.html#setup-git [self-how-git-is-different]: git-guide.html#how-git-is-different [self-git-terms]: git-guide.html#important-git-terms diff --git a/docs/index.rst b/docs/index.rst index d95ff3d77a..62b60816c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -83,6 +83,7 @@ Contents: writing-views life-of-a-request reading-list + screenshot-and-gif-software .. _code-contribution-guide: diff --git a/docs/screenshot-and-gif-software.md b/docs/screenshot-and-gif-software.md new file mode 100644 index 0000000000..87b88efb88 --- /dev/null +++ b/docs/screenshot-and-gif-software.md @@ -0,0 +1,41 @@ +# Screenshot and GIF software + +The following list documents different screenshoting & GIF-making techniques and +free software. We encourage you to make use of these when making front-end pull +requests, as other contributors can see the changes you have made without having +to checkout your branch. + +## Screenshot tools by platform +### Browser +- [LightShot Screenshot](https://app.prntscr.com/en/index.html) (Chrome, Firefox, IE & Opera) + +### MacOS +- Command-Shift-3 to capture all of the screen +- Command-Shift-4 and drag cursor to select a specific area +- [LightShot Screenshot](https://app.prntscr.com/en/index.html) +- [Gyazo](https://gyazo.com/en) + +### Windows +- Snipping Tool (inbuilt) +- [LightShot Screenshot](https://app.prntscr.com/en/index.html) +- [Gyazo](https://gyazo.com/en) + +### Linux +- gnome-screenshot (inbuilt, you can use Ctrl-Shift-PrtScn as a shortcut for its “select an area to grab” feature) + +## GIF tools by platform +### Browser +- [GIPHY](https://giphy.com) + +### MacOS +- [GIPHY](https://giphy.com/apps/giphycapture) +- [GIF Brewery](http://gifbrewery.com/) +- [Gyazo GIF](https://gyazo.com/en) + +### Windows +- [ScreenToGif](http://www.screentogif.com/) +- [Gyazo GIF](https://gyazo.com/en) + +### Linux +- [SilentCast](https://github.com/colinkeenan/silentcast) +- [Peek](https://github.com/phw/peek)