Git Product home page Git Product logo

guides's Introduction

Guides

Guides for getting things done, programming well, and programming in style.

High level guidelines:

  • Be consistent.
  • Don't rewrite existing code to follow this guide.
  • Don't violate the conventions without a good reason.

A note on the language:

  • "Avoid" means don't do it unless you have good reason.
  • "Don't" means there's never a good reason.
  • "Prefer" indicates a better option and its alternative to watch out for.
  • "Use" is a positive instruction.

Credits

Thanks to thoughtbot from whom these guides are based.

These guides are maintained by Subvisual The names and logos for Subvisual are trademarks of GB-Software As A Service, Lda.

These guides are © 2017 GB-Software As A Service, Lda. They are distributed under the Creative Commons Attribution License.

guides's People

Contributors

zamith avatar naps62 avatar frm avatar jferris avatar joaojusto avatar rmdmachado avatar gabrielpoca avatar pfac avatar azevedo avatar davidesilva avatar hgmnz avatar mike-burns avatar

Stargazers

José Gomes avatar Mirha Masala avatar laserx avatar Misha Tsankashvili avatar Bruno Correia avatar Ismail Mechbal avatar Krzysztof Szromek avatar António Lima avatar  avatar Yusef Habib avatar Lim Choon Yun (Marco) avatar Adrian Ching avatar chinloong avatar An Yu avatar Sergey Ivanes avatar Luís Braga avatar Dylan Bishop avatar Pedro Caseiro avatar Sérgio Simões avatar Simao avatar Benjamim Sonntag avatar  avatar Matt Zimmermann avatar Christian Meunier avatar Denis Borovikov avatar

Watchers

 avatar  avatar  avatar Ronaldo Sousa avatar  avatar Mário Abreu avatar James Cloos avatar  avatar  avatar  avatar Pedro Oliveira avatar  avatar João avatar

guides's Issues

Typo

"decifer" should be spelled "decipher"

Should we add a default license?

Following #41 I was wondering if it would be a fair idea to add a default LICENSE template for open source projects.

If so, any LICENSE suggestions?

CSS properties order

This has already been talked about. It was an issue in this repo as well but got deleted probably when this repo stopped being a fork.

It has a trello card.

@gabrielpoca and I still believe this could have a revamp even in the actual properties order which might be "outdated" and missing some properties like those from the flexbox module.
The reasons are stated in the trello card, but for us the main reason for not liking the current order (alphabetical) is because it's not logical, even though it's an alphabetical order it feels random. It doesn't translate the "semanticness" of a ruleset.

Ruby identation of conditions within assignments

The setting we currently have in Rubocop enforces this:

value = if condition
          1
        else
          2
        end

Personally, I like it, but I believe some people prefer the other option:

value = if condition
  1
else
  2
end

My only issue with changing is that vim's auto-indent currently does the first option. If we change rubocop, we need to change vim as well, which I don't know how to do.

This was created because @zamith and I started this discussion during a code review.

PS: let's please not start a discussion about which one is better or why, and just focus on the decision and the vim issue 🐼

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.