Contributing docs should ask for screenshots?

openhatch / oh-mainline

The code that runs openhatch.org

http://openhatch.org

GNU Affero General Public License v3.0

241 stars 311 forks source link

Contributing docs should ask for screenshots? #1645

Open phildini opened 9 years ago

phildini commented 9 years ago

This is more a reminder to myself, but comments or PRs about the issue totally welcome!

I think we should add a line in the contributor's guide saying we greatly encourage attaching screenshots to PRs that have frontend changes. The first version of this could just say so as a line item, we could also expand it to link to a doc on taking screenshots and explain why we want them.

paulproteus commented 9 years ago

but also, we have an overdue TODO to have auto-deploy-on-Heroku be part of the pull request process, which might even obviate some of the need for screenshots.

willingc commented 9 years ago

+1 to both comments.

SanketDG commented 8 years ago

@ehashman pointed me to this issue.

Should I write on taking screenshots or recording gifs?

The software I use for screenshots and recording is Kazam which is excellent.

Screenshots are straight forward jpeg files. About recordings, they are stored in mp4.

First I upload the mp4 file to https://vid.me/ which requires no account.
Then I use http://imgur.com/vidgif, put in the link I got from vid.me, get my gif file.

Is this process okay, and not tedious enough? I wanted to use web apps as much as possible, to be more suitable to beginners. AFAIK this can be done on the command line too.

willingc commented 8 years ago

Hi @SanketDG, Writing about taking screenshots and gifs would be a good addition to the documentation. :smile_cat:

Here's another option for creating GIFs. For those using windows and OS X, licecap is also a good option. We use it on Project Jupyter to create GIFs for user interface stuff.