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

Sub Categories #3

Open
BenjaminRCooper opened this issue Oct 1, 2013 · 24 comments
Open

Sub Categories #3

BenjaminRCooper opened this issue Oct 1, 2013 · 24 comments

Comments

@BenjaminRCooper
Copy link
Contributor

So we have agreed on our main categories, but our first task is to come up with the relevant sub-categories for each main category e.g. Markup -> Formatting.

What do you think we should have?

Also, I feel the best way to approach the standards is to work our way down the document, top to bottom, so we have some structure and it does'nt get messy. What do you all think?

Ben

@ghost ghost assigned BenjaminRCooper Oct 1, 2013
@lewismorris
Copy link

I was thinking that maybe we should have separate sub-categories for each language that we use e.g.

Markup
-> HTML
-> Formatting
-> Rules
-> CSS
-> Frameworks

Let me know your thoughts.

@BenjaminRCooper
Copy link
Contributor Author

Just to ellaborate on this, the categories which are currently live are based on the following;

Markup - Global HTML standards, any supersets e.g. Jade, HAML will be contained within here as sub-categories, with sub-categories contained within the superset for specific areas.
Presentation - Global CSS standards, any supersets e.g. SASS, LESS, Stylus will be contained within here as sub-categories, with sub-categories contained within the superset for specific areas.
Behaviour - Global JS standards, any supersets e.g. Coffeescript, JQuery, Dart, TypeScript will be contained within here as sub-categories, with sub-categories contained within the superset for specific areas.

What do you guys think?

Can we look into contributing some sub-categories before the meeting on Monday please? Aim is to have 3/4 for each category to start with, with the option to add categories as we go.

Ben

@lewismorris
Copy link

Hey Ben,

Just making i understand this right, Categories and Sub-Categories will be layout out like the following:

Markup
01 Global (HTML)
02 HAML
03 Jade

Presentation
01 Global (CSS)
02 Sass/Scss
03 Less

Let me know if i've understood this correctly, if so i'll contribute the basic sub-categories over the weekend.

@BenjaminRCooper
Copy link
Contributor Author

Morning mate,

Not quite, it's more like the following.

Markup

1.) Formatting
2.) Naming Conventions
3.) HAML
3.1) **A category specific to HAML as a preprocessor

Let me know if you feel we should do it another way.

Just a shot in the dark at the moment to start us off.
Ben

@BenjaminRCooper
Copy link
Contributor Author

I think we can safely say that Formatting would be a sub-category for the following categories;

  • Markup
  • Presentation
  • Behaviour

What do you think?

Ben

@lewismorris
Copy link

Thanks for getting back to me Ben, that clears things up with me.

I think Formatting and Naming Conventions would fit into a sub-category for all three. Let me know your thoughts on this.

Lewis

@BenjaminRCooper
Copy link
Contributor Author

I agree, but with regards to naming conventions for Markup and Presentation, I feel this would only relate to one or the other.

What do you think?

I think we should have Naming Conventions for both Markup and Behaviour, as it would relate more to Markup, than it would Presentation.

Ben

@lewismorris
Copy link

I think it's a 50/50 split between whether it's related to Markup or Presentation, for me personally i think it'd fit under Presentation more. For example BEM is a Naming Convention within CSS which would fit under Presentation.

Regardless of which category we decide to put it under the category where it isn't placed should reference the category where it is placed in my opinion.

Lewis

@timgale
Copy link

timgale commented Oct 4, 2013

With regards to the placement of naming conventions, I would agree with Lewis that it is a category that concerns both markup and presentation, but given that element names contribute to the structure of the document I would say it would be more appropriate to place this under markup.

This also relates well to the BEM documentation, as this discusses how the methodology can be scaled across both presentation and behaviour, so perhaps it would not be wise to limit this to just CSS.

Tim

@BenjaminRCooper
Copy link
Contributor Author

Just to add, Tim spent a good 20 minutes writing that reply.

It was well thought out.

Ben

@lewismorris
Copy link

Hey Tim,

Good reply, if we're going to run with BEM ( Which it is more than likely we will as we're all in agreement in #2 ) then i agree completely with what you have said above.

Lewis

@jamesmills
Copy link
Member

Keep it up! I see awesome work in the making!

@BenjaminRCooper
Copy link
Contributor Author

Some Categories;

Markup

  • General (anything which doesnt apply to formatting)
  • Formatting (could be comments, tabbing etc)
  • Naming Conventions (BEM, JS specific classes)
  • Example (Example code which contains all MUSTS)

Presentation

  • General ( Anything which doesnt apply to formatting )
  • Formatting ( Could be comments, tabbing, single line vs multi line etc )
  • Example ( Example code which contains all MUSTS )

Behaviour

  • General ( Anything which doesnt apply to formatting )
  • Formatting ( Could be comments, tabbing etc )
  • Naming Conventions ( Naming object, variables or functions, private vs public )
  • Example ( Example code which contains all MUSTS )

Performance

  • General ( Anything which doesnt quite fit inside the other sub-categories )
  • Network ( Maybe consist of things such as prefetching etc )
  • Images ( Anything additional which something such as Grunt or Codekit doesn't take care of )
  • CSS ( Selectors are read right to left, Reflow )
  • JavaScript ( Caching variables in loops etc )

Accessiblity

  • General
  • HTML ( WAI-ARIA, Microformats )
  • CSS ( IR classes )

Let me know, what you guys think.

Ben

@jonspark
Copy link

jonspark commented Oct 6, 2013

Will JS patterns come in anywhere?

@BenjaminRCooper
Copy link
Contributor Author

They will do mate, just for the moment I wanted to get some basic categories which we can extend on once we start contributing actual guidelines.

I was thinking for the behaivour guidelines, we could split it down a lot further than the Markup and Presentation sections, as I feel we could use it as a guide to JS as we all lack experience writing it.

What you think?

So having sub-categories for hoisting and constructors etc, and going a bit deeper.

Ben

@jonspark
Copy link

jonspark commented Oct 6, 2013

What about splitting it out? The behaviour stuff here could cover the basic patterns, selector optimisation and simple performance. For something of the scale of JS applications and serious optimisation, the topic is so large, we could probably start a whole separate JS handbook.

@BenjaminRCooper
Copy link
Contributor Author

I agree completely mate, this sounds like the best approach.

This is basically going to be your area and it would be great for your guidance regarding the behavioural aspect of the guidelines.

Will open an issue for a JS handbook.

Ben

@BenjaminRCooper
Copy link
Contributor Author

Leaving this issue open, as it is ongoing.

B

@BenjaminRCooper
Copy link
Contributor Author

Additional categories:

Presentation:

  • Debugging & Browser Support

Behaviour:

  • Debugging & Browser Support

Ben

@BenjaminRCooper
Copy link
Contributor Author

Would like to add, Markup - Comments as a category, due to #25.

@BenjaminRCooper
Copy link
Contributor Author

Would like to add, Presentation - Comments

@BenjaminRCooper
Copy link
Contributor Author

Sass sub category for Presentation, with its own set of sub-categories for format etc.

@BenjaminRCooper
Copy link
Contributor Author

Removed Performance as a category, as it may be a little too much for version 1.0

@BenjaminRCooper
Copy link
Contributor Author

Want to add performance back to being a category, as it doesn't make sense not to have performance standards when you look at our ethos. I propose we add it and put it on the back burner, as we have other things currently running.

Thoughts?

Ben

@BenjaminRCooper BenjaminRCooper removed their assignment May 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants