Commenting CSS #28

michaelspellacy · 2016-09-09T19:33:23Z

@dmechlin Asked me what my thoughts were in having UI's add their name/comment to the Sass/CSS, especially the lead on a project, so that we can easily reach out to each other if there are any issue on any given site. I do it out of habit for that reason and because an artist should ALWAYS sign their work. :-) Thoughts? I always found it convenient.

michaelspellacy · 2016-09-09T19:36:05Z

That or humans.txt. :-)

http://humanstxt.org/

Brockenstein · 2016-09-10T02:36:18Z

I think it is only useful if everyone tracks exactly what they did to a site after the original author did the site in this file. Because these days, we can easily see who made the original site in in version history. So I personally don't see the point if its only tracking initial developer. But whatever the team wants to do is fine with me.

I try to make most my comments as // so they don't appear in the production file. I believe though /*! will keep your comment from minifying.

stephendelancey · 2016-09-10T04:57:33Z

In the compressed css file, all comments are taken out. In scss /* comments are just multi line comments. They will only come out in the compiled css file if set to in the compiler.

TB compiler is set to extract that unless it changed in the past 4 months or so.

dmechlin · 2016-09-12T13:44:19Z

I want everyone that goes to the site to see the author. Including those who have access to version history and those who do not. I want traffic and management to easily go to any site that we built and quickly identify the person who built it. If we need to know who made a change and have to dig, we can go into version history and dig around. This will really help us when assigning projects and various reporting and researching task. Maybe even a link to the original build request JIRA ticket.

Brock - can we test your non minifying comment solution?

Example

/*!
Title: Panera Bread - Talentbrew
Author: TMP Worldwide - Louisville
Brock Barnett
brock.barnett@tmp.commailto:brock.barnett@tmp.com
Creation: 2016-09-08
*/

michaelspellacy · 2016-09-12T13:58:03Z

@stephendelancey Non-minifying comments work. Always have. Built into Sass. I'm paranoid about spam, so I always use [at] in place of @, but whatever you guys want. :-) I use this on tmp to show our font licensing copyright, etc.

/*!
Title: Panera Bread - Talentbrew
Lead: Brock Barnett (brock.barnett[at]tmp.com)
Contributors: Rebecca Hammer (rebecca.hammer[at]tmp.com), Michael Spellacy (michael.spellac[at]tmp.com)
Creation: 2016-09-08
*/

I don't think location is necessary, We want this to be as easy for devs to drop in or update as is possible.

Is creation the launch date?

Brockenstein · 2016-09-12T14:14:51Z

Creation should be when the site is either started by the original dev or at latest sent to QA. If its launch date that could be a year from actual creation.

Also is there any real reason to have the emails? Name alone should work fine as it is intended really for internal use it sounds like.

lenawan · 2016-09-12T14:15:51Z

I usually add the Author information on the TB1.0 sites that includes my
email address. But I got a lot of junk emails. Now I'm still receiving
emails from a unknown person.
I think the author's information and the changing history is important for
the maintenance and troubleshooting. But, no email address. May use the
user name instead of the developers name.

On Mon, Sep 12, 2016 at 9:58 AM, michaelspellacy notifications@github.com
wrote:

@stephendelancey https://github.com/stephendelancey Non-minifying
comments work. Always have. Built into Sass. I'm paranoid about spam, so I
always use [at] in place of @, but whatever you guys want. :-)

/*!
Title: Panera Bread - Talentbrew
Lead: Brock Barnett (brock.barnett[at]tmp.com)
Contributors: Rebecca Hammer (rebecca.hammer[attmp.com), Michael Spellacy
(michael.spellac[at]tmp.com)
Creation: 2016-09-08
*/

I don't think location is necessary, We want this to be as easy for devs
to drop in or update as is possible.

Is creation the launch date?

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#28 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEzvqqbhCqSHdNCm4iqq-akKh-amphBjks5qpVpsgaJpZM4J5Yhs
.

michaelspellacy · 2016-09-12T14:15:54Z

Yeah, I agree. Email can be optional. Okay on date.

michaelspellacy · 2016-09-12T14:18:45Z

@lenawan I don't get a ton of spam, so perhaps [at] is a decent deterrent. If you do include email, just use that replacement, instead. It might help.

lenawan · 2016-09-12T14:22:04Z

That's a good idea!

Sent from my iPhone

On Sep 12, 2016, at 10:18 AM, michaelspellacy notifications@github.com wrote:

@lenawan I don't get a ton of spam, so perhaps [at] is a decent deterrent. If you do include email, just use that replacement, instead. It might help.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

stephendelancey · 2016-09-13T05:09:16Z

It sounds like adding a comment block to scss won't help solve Dave's problem. Scss is less visible then version history is.

Spell, just for clarity sake this is where my brain is for comments:
// and /* are scss single and multi line comments that do not appear in compiled css.

@* comments are razor/c# comments there for only server side.

Brockenstein · 2016-09-13T10:59:23Z

@stephendelancey try

/*!
This multiline comment
place it at the top of your scss
It should not minify
due to the exclamation mark
*/

lenawan · 2016-09-13T13:48:03Z

I added this comments to my current project:
/*
Author: @lenaw
Ticket: TCDQ-15552
Completed on: 09-13-2016
DPM: angelaG & kwasaM
QA:
Changed on:
=============================================*/

On Tue, Sep 13, 2016 at 6:59 AM, Brock Barnett notifications@github.com
wrote:

@stephendelancey https://github.com/stephendelancey try

/*!
This multiline comment
place it at the top of your scss
It should not minify
due to the exclamation mark
*/

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#28 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEzvqqrYGjjt8BHdewq9hor7yeF3Y-Moks5qpoIMgaJpZM4J5Yhs
.

michaelspellacy · 2016-09-13T13:54:37Z

Including your JIRA handle not something I considered. Good idea. :-)

lenawan · 2016-09-13T14:10:45Z

We can track everything with ticket number. Then we can shorten the
comments.Maybe something like this:

(1)
/TCDQ-15552/

(2)
/*
Author: @lenaw
Ticket: TCDQ-15552
Completed on: 09-13-2016
===============================*/

On Tue, Sep 13, 2016 at 9:54 AM, michaelspellacy notifications@github.com
wrote:

Including your JIRA handle not something I considered. Good idea. :-)

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#28 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEzvqpsHWy0lIDp_Ypj0xTi6Obgeha9Pks5qpqsdgaJpZM4J5Yhs
.

lenawan · 2016-09-13T14:12:50Z

but the changing history should be appended after that

On Tue, Sep 13, 2016 at 10:09 AM, contactport contactport@gmail.com wrote:

We can track everything with ticket number. Then we can shorten the
comments.Maybe something like this:

(1)
/TCDQ-15552/

(2)
/*
Author: @lenaw
Ticket: TCDQ-15552
Completed on: 09-13-2016
===============================*/

On Tue, Sep 13, 2016 at 9:54 AM, michaelspellacy <notifications@github.com

wrote:

Including your JIRA handle not something I considered. Good idea. :-)

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#28 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEzvqpsHWy0lIDp_Ypj0xTi6Obgeha9Pks5qpqsdgaJpZM4J5Yhs
.

stephendelancey · 2016-09-13T15:56:08Z

http://stackoverflow.com/questions/16844408/which-output-styles-remove-multiline-line-comments

Answer to scss compiling
You guys are using compressed so the only way to keep multi line comments is to make them loud with !
So it would be /* ! I am a loud comment*/

michaelspellacy · 2016-09-13T16:02:34Z

@lenawan That is fine, you just have to add the ! to the comment, as indicated above in various comments. This is so it is not stripped and can be easily accessed by all.

michaelspellacy · 2016-09-13T16:15:25Z

Again, in making this simple, I think all we need here is:

/*!
Title: Panera Bread - Talentbrew
Lead: Brock Barnett (brock.barnett[at]tmp.com, @bbarnett)
Contributors:
Rebecca Hammer (rebecca.hammer[at]tmp.com)
Michael Spellacy (michael.spellac[at]tmp.com)
Ticket: TB-123
*/

Email addresses are optional. Since Creation is more a date range, do we even need to include? Ticket enough to provide that detail, I think. This is just quick overview of info.

dmechlin · 2016-09-13T16:34:04Z

Yes, perfect!

Dave

812-989-9993

On Sep 13, 2016, at 12:15 PM, michaelspellacy <notifications@github.com mailto:notifications@github.com> wrote:

Again, in making this simple, I think all we need here is:

/*!
Title: Panera Bread - Talentbrew
Lead: Brock Barnett (brock.barnett[at]tmp.comhttp://tmp.com, @bbarnetthttps://github.com/bbarnett)
Contributors:
Rebecca Hammer (rebecca.hammer[at]tmp.comhttp://tmp.com)
Michael Spellacy (michael.spellac[at]tmp.comhttp://tmp.com)
Ticket: TB-123
*/

Email addresses are optional. Since Creation is more a date range, do we even need to include? Ticket enough to provide that detail, I think. This is just quick overview of info.

You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com//issues/28#issuecomment-246736672, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AH0wDhtuK07lNfLVEv6V0nqa0Rqb9_OLks5qpswegaJpZM4J5Yhs.

lenawan · 2016-09-13T17:42:02Z

oh yes.
I added.
https://tbcdn.talentbrew.com/company/1769-preview-site/css/3210-Full.css
thank for reminding me!

On Tue, Sep 13, 2016 at 12:02 PM, michaelspellacy notifications@github.com
wrote:

@lenawan https://github.com/lenawan That is fine, you just have to add
the ! to the comment, as indicated above in various comments. This is so it
is not stripped and can be easily accessed by all.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#28 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEzvqkXu8D7k0O6XVQNrqYJvVZcGXPeTks5qpskagaJpZM4J5Yhs
.

bbarnett · 2016-09-13T17:59:49Z

you guys should probably take me off this email thread. I'm not the
"barnett" you're looking for.

On 16-09-13 10:42 AM, lenawan wrote:

oh yes.
I added.
https://tbcdn.talentbrew.com/company/1769-preview-site/css/3210-Full.css
thank for reminding me!

On Tue, Sep 13, 2016 at 12:02 PM, michaelspellacy
notifications@github.com
wrote:

@lenawan https://github.com/lenawan That is fine, you just have to add
the ! to the comment, as indicated above in various comments. This
is so it
is not stripped and can be easily accessed by all.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub

#28 (comment),
or mute the thread

https://github.com/notifications/unsubscribe-auth/AEzvqkXu8D7k0O6XVQNrqYJvVZcGXPeTks5qpskagaJpZM4J5Yhs
.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#28 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AA_9-8lF_YgwJ7w71sYOAOQOvgqDYFYeks5qpuBrgaJpZM4J5Yhs.

michaelspellacy · 2016-09-13T18:01:36Z

@bbarnett Ha! ha! Sorry about that!

Brockenstein · 2016-09-15T21:51:39Z

So I think I am going to go with this for my site. As it seems easiest on my eyes to read. I am dropping the email and only doing the jira tag.

/*!

          Title: Panera Bread - Talentbrew
         Author: TMP Worldwide - Louisville
 Lead Developer: Brock Barnett (@bbarnett) 
   Contributors: Rebecca Hammer (@rhammer)
                 Michael Spellacy (@mspellacy)
Creation Ticket: TCDQ-15843
  Creation Date: 2016-mm-dd

*/

I know its already been stated that this is only for creation but we keep running into the problem of trying to figure out who last edited what and why those changes haven't been pushed yet. So maybe we should look back into comments from the Product Support Devs. I am talking about any edits that are made after the original dev makes the site because some sites have tons of changes before launch.

/*!
          Title: Panera Bread - Talentbrew
         Author: TMP Worldwide - Louisville
 Lead Developer: Brock Barnett (@bbarnett) 
   Contributors: Rebecca Hammer (@rhammer)
                 Michael Spellacy (@mspellacy)
Creation Ticket: TCDQ-15843
  Creation Date: 2016-mm-dd

Post-Creation Changes

         Ticket: TCDQ-15844
      Developer: Adam Taylor (@actaylor)
        Manager: Pss or DPM name
    Change date: 2016-mm-dd
   Dev comments: New Banner Images

*/

michaelspellacy · 2016-09-20T14:51:27Z

I'm down with this, but I don't think Author is required as it is implied. For contact method, feel free to add JIRA handle, but use whatever the best way to contact you may be.

Here is the thing, though. When it comes to changes to a site, we do more than just edit CSS, right? It would be really nice if we could come up with a process for implementing a changelog. Something like jobs.sitename.com/changelog

michaelspellacy · 2016-09-20T14:53:17Z

Format similar to this: http://keepachangelog.com/en/0.3.0/

michaelspellacy · 2016-09-20T15:02:00Z

We would need to create it, per site, naturally, but would really need to get people into the habit of maintaining it. Hard to do, but perhaps no more difficult than getting folks to update the comments in the CSS. I mean, as good developer habits go, it behooves you to keep a log no matter where it may be.

michaelspellacy added the question label Sep 9, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commenting CSS #28

Commenting CSS #28

michaelspellacy commented Sep 9, 2016 •

edited

michaelspellacy commented Sep 9, 2016 •

edited

Brockenstein commented Sep 10, 2016 •

edited

stephendelancey commented Sep 10, 2016

dmechlin commented Sep 12, 2016 •

edited by Brockenstein

michaelspellacy commented Sep 12, 2016 •

edited

Brockenstein commented Sep 12, 2016

lenawan commented Sep 12, 2016

michaelspellacy commented Sep 12, 2016

michaelspellacy commented Sep 12, 2016

lenawan commented Sep 12, 2016

stephendelancey commented Sep 13, 2016

Brockenstein commented Sep 13, 2016

lenawan commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016 via email

lenawan commented Sep 13, 2016

lenawan commented Sep 13, 2016

stephendelancey commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016

dmechlin commented Sep 13, 2016

lenawan commented Sep 13, 2016

bbarnett commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016

Brockenstein commented Sep 15, 2016

michaelspellacy commented Sep 20, 2016 •

edited

michaelspellacy commented Sep 20, 2016

michaelspellacy commented Sep 20, 2016 •

edited

Commenting CSS #28

Commenting CSS #28

Comments

michaelspellacy commented Sep 9, 2016 • edited

michaelspellacy commented Sep 9, 2016 • edited

Brockenstein commented Sep 10, 2016 • edited

stephendelancey commented Sep 10, 2016

dmechlin commented Sep 12, 2016 • edited by Brockenstein

michaelspellacy commented Sep 12, 2016 • edited

Brockenstein commented Sep 12, 2016

lenawan commented Sep 12, 2016

michaelspellacy commented Sep 12, 2016

michaelspellacy commented Sep 12, 2016

lenawan commented Sep 12, 2016

stephendelancey commented Sep 13, 2016

Brockenstein commented Sep 13, 2016

lenawan commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016 via email

lenawan commented Sep 13, 2016

lenawan commented Sep 13, 2016

stephendelancey commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016

dmechlin commented Sep 13, 2016

lenawan commented Sep 13, 2016

bbarnett commented Sep 13, 2016

michaelspellacy commented Sep 13, 2016

Brockenstein commented Sep 15, 2016

michaelspellacy commented Sep 20, 2016 • edited

michaelspellacy commented Sep 20, 2016

michaelspellacy commented Sep 20, 2016 • edited

michaelspellacy commented Sep 9, 2016 •

edited

michaelspellacy commented Sep 9, 2016 •

edited

Brockenstein commented Sep 10, 2016 •

edited

dmechlin commented Sep 12, 2016 •

edited by Brockenstein

michaelspellacy commented Sep 12, 2016 •

edited

michaelspellacy commented Sep 20, 2016 •

edited

michaelspellacy commented Sep 20, 2016 •

edited