Git Product home page Git Product logo

Comments (7)

cdl avatar cdl commented on August 17, 2024

I agree with this - explaining "why" is key when it comes to resources that are meant to be learnt from. If this isn't feasible, you should probably include a notice stating that these are merely suggestions based on personal opinions, and these guidelines are not intended to be a definitive guide to good practice, nor something that beginners should be learning from.

from frontend-guidelines.

AsifMushtaq avatar AsifMushtaq commented on August 17, 2024

I also agree with above suggestion. We have a very good example of John Papa's AngularJs Style guide which explain his relational behind every given style guideline.

from frontend-guidelines.

conwaydev avatar conwaydev commented on August 17, 2024

I definitely agree with this suggestion, I feel like a lot of developers can easily become dissuaded by the advice that you're giving without proper context of why these are good decisions or proper guidelines.

from frontend-guidelines.

danzimm avatar danzimm commented on August 17, 2024

I just want to comment - I am a new web developer of sorts, and read this. I was in fact quite dissuaded by several things as @conwaydev suggested might be the case.

from frontend-guidelines.

aweary avatar aweary commented on August 17, 2024

It'd be wise to specify who your audience is as well. As mentioned in #26 the Javascript section uses ES6 features that aren't going to be available unless you use a transpiler. It's a valid argument that ES6 is the future of Javascript and should be used when possible, but I don't think it's safe to assume that the average beginner is going to be as comfortable understanding ES5 vs ES6, the current state of browser implementations, why a transpilier is needed at the moment, etc.

The guide covers some really basic front-end concepts in CSS/HTML yet you're assuming a lot of the reader here when it comes to Javascript. It just doesn't seem like its being consistent with its expectations of the reader.

The best option, I'd say, is to create an introduction explaining the target audience and expected level of competence. Outline which features here are non-standard within the current browser environment (this is a front-end guide after all, not a guide on the current Javascript standard) and how they can be used now via something like Babel.

from frontend-guidelines.

prayerslayer avatar prayerslayer commented on August 17, 2024

I agree with all previous commenters and think a disclaimer of sorts should be mandatory.

Your points make sense to an experienced developer. Or at least she will understand what your tradeoffs are. To a new developer some points probably seem arbitrary, ie.

Avoid animating other properties than opacity and transform.

Why? What's wrong with color? Why is margin-left bad and translateX good?

from frontend-guidelines.

bendc avatar bendc commented on August 17, 2024

@prayerslayer Because opacity and transform are the only properties fast to animate.

Closing this issue but keeping this suggestion in mind :)

from frontend-guidelines.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.