Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Name can be confusing #76

Open
SamHasler opened this issue Jan 13, 2016 · 6 comments
Open

Name can be confusing #76

SamHasler opened this issue Jan 13, 2016 · 6 comments

Comments

@SamHasler
Copy link

Seeing this comment reminded me of a discussion I had with my my manager where I had to explain what CSSCritic was (after talking about it to him previously) because he'd assumed it was a critiquing / linting tool (i.e. something like Parker).

Would you consider renaming csscritic to something that better represents what it is used for?

@cburgmer
Copy link
Owner

Hey, name changes do carry a certain risk, but I can understand your point. Suggestions?

@SamHasler
Copy link
Author

renderUnit – "render" as it can be used for rendering components (i.e.
checking JS still output the same HTML) as well as CSS. "unit" for obvious
reasons, but also to emphasise it is best for discrete parts rather than
whole pages. Unit also creates expectations of fast tests and a quick
test/change/repeat loop.

Although render has connotations of CGI it's also used frequently for the
web and HTML/CSS. e.g. http://2016.render-conf.com/

On 13 January 2016 at 12:53, Christoph Burgmer notifications@github.com
wrote:

Hey, name changes do carry a certain risk, but I can understand your
point. Suggestions?


Reply to this email directly or view it on GitHub
#76 (comment).

@cburgmer
Copy link
Owner

Hmm, I'd like to have the name directly relate to "testing" (yes, csscritic does a bad job at that :)

I agree that we test more than CSS, actually HTML, JS and other assets. Also, you might want to use csscritic to just supervise screenshots you have obtained differently (I was trying to get my last team to test the PDFs that otherwise directly went to production without any automated test).

@edouard-lopez
Copy link

Usage

When I started to use it I stop to consider which location and name would be the more meaningful for team-mate that would work on the project.

  1. I placed it under ./tests/ ;
  2. named it visual-regression.html ;
  3. take full page screenshot (need to work on that).

csscritic-naming

Suggestions

Reading you I was thinking to the following names:

  • visual-regression ;
  • visual-diff ;
  • visual-testing ;
  • visual-regression-testing ;
  • ui-diff: User Interface diff, the use of diff is self-explanatory for a lot of developer ;
  • ui-test: User Interface testing but I think it's confusing, it makes me think about selenium. But IMHO your approach is more "passive" as it doesn't test behavior (in my use cases) ;
    I don't think using unit is a good idea as it not really automatic testing.

Renaming

Github do transparent redirect when you rename your repo.

Question

  • How do you test PDF with it?

@SamHasler
Copy link
Author

visual-regression. yes! That's exactly how I described it in our department
wiki.

Something like "Visual Regression Tester" would work.

On 13 January 2016 at 14:32, Édouard Lopez notifications@github.com wrote:

Usage

When I started to use it I stop to consider which location and name would
be the more meaningful for team-mate that would work on the project.

  1. I placed it under ./tests/ ;
  2. named it visual-regression.html ;
  3. take full page screenshot (need to work on that).

[image: csscritic-naming]
https://cloud.githubusercontent.com/assets/1212392/12296579/dfd76e12-ba08-11e5-9024-8d25ce149c31.png
Suggestions

Reading you I was thinking to the following names:

  • visual-regression ;
  • visual-diff ;
  • visual-testing ;
  • visual-regression-testing ;
  • ui-diff: User Interface diff, the use of diff is self-explanatory
    for a lot of developer ;
  • ui-test: User Interface testing but I think it's confusing, it makes
    me think about selenium. But IMHO your approach is more "passive" as
    it doesn't test behavior (in my use cases) ; I don't think using unit
    is a good idea as it not really automatic testing.

Renaming

Github do transparent redirect when you rename your repo
https://developer.github.com/changes/2015-07-21-automatic-redirects-for-renamed-repositories/
.
Question

  • How do you test PDF with it?


Reply to this email directly or view it on GitHub
#76 (comment).

@cburgmer
Copy link
Owner

Suggestions

I think the terms you are listing are a very good match to what it does. I'd love to see this somewhat in the name. For me a name is more than that though. Something that sticks when you read an article, when you talk about it, something you can relate to personally. And also something that differentiates itself from other similar tools.

Renaming

Thanks for the hint, that will help for sure.

Question

My last project was generating PDFs with mock data for manual review (that may or may not happen). Given more time I would have

  1. Created a job to convert the PDF front pages to a PNG (I think convert from imagemagick does the trick)
  2. Load up those PNGs inside csscritic, so our devs working on the layout/our quality people could have a look into changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants