Comments (6)
I generally don't like the idea of two style guides because I feel it may defeat the purpose of having a style guide. Should we just focus all our efforts in either this one or @lexmag's one? (btw @lexmag, great work ๐ :) )
from elixir_style_guide.
To throw more fuel on the fire, there's also the style checker Dogma with its own set of rules.
from elixir_style_guide.
Hey @whatyouhide, I don't really think of my guide as of the community-driven (at least for now), it's purely opinionated.
It states a style I developed working with Elixir during last 2 years, it works for my colleagues and friends of mine.
I'd be happy if it works for everyone without any adjustment, but it may have some rules which don't appeal to everyone, though I consider them practical and pragmatic, e.g. https://github.com/lexmag/elixir-style-guide#zero-arity-parens.
Thus I just think current guide can benefit from mine โ borrow and adjust some points (if it's needed).
from elixir_style_guide.
@lexmag thanks for the heads-up, and congratulations for the good job.
Actually you have done it, but i wanted to contribute to this guide based on the latest changes done prior to the release of Elixir v1.1 that were done cleaning up code, but i think you pretty much got everything in your guide.
I have read it, and will re-read it and contribute to it, as I am keeping track of all the changes I made to cleanup code in elixir, and also contribute them to this guide.
Regarding having more than one style-guide, I think we can benefit much more by having different sources to take ideas from (provided that licenses are compatible), specially as @lexmag said, when a lot of those choice could be just considered personal taste.
from elixir_style_guide.
Same as we have a section for tools, I think we should have a section for Other Style guides
and include this one and other relavant ones that people might create in the future.
as they can help people to expand their own ideas (and also contribute to this guide)
from elixir_style_guide.
My 2 cents...
The truth of the matter is there are really good arguments for most intentional stylistic decisions. The only real purpose of a style guide is as documentation of which decisions have been made to try to keep a group of people in line with those decisions.
I have very little patience for most of the stylistic arguments that happen myself. I have some preferences of my own but I tend to just follow whatever other people are doing on a project I'm working on.
Every job I've been at has held everyone to a different style guide even when I've used the same language at different jobs. We have our own private style guide at my current job for Javascript, for example. As another example, look at just how many open source Ruby style guides exist on Github.
It's totally natural for people to disagree with points in a particular style guide and roll their own for their own team's purposes. Totally fine.
As @lexmag has said above, his style guide is not intended to be community driven but opinionated according to its maintainers (at the moment, @lexmag and one other Github user).
This style guide is meant to be community driven. I almost don't contribute at all besides paying attention to PRs and trying to stay ready to diffuse situations if they occur (they haven't yet phew) . I only support it as a good place to point Elixir beginners because A) It happens to be in the Dave Thomas book last time I checked and B) It's gotten a lot of stars and contributors ๐. If another repo surpasses it, ๐.
Feel free to pull ideas from @lexmag's guide and open PRs to this repo if you think they should be included.
Feel free to add an Other Style Guides section if you think that's a good choice.
ยฏ_(ใ)_/ยฏ
from elixir_style_guide.
Related Issues (20)
- camelCase vs PascalCase HOT 3
- Add preference for long args/`when` in methods? HOT 3
- Does the formatter make this obsolete? HOT 3
- Missing a section about maps HOT 5
- @module_attribute should be moved higher in Module attribute ordering HOT 1
- Establishing Guidelines for Maximizing Anonymous Function Readability in Reference to Escaped and Expanded Notations HOT 3
- Suggestion on Module Attribute Ordering HOT 1
- Thoughts on public/private function ordering HOT 4
- Deeply nested one-arity function calls? HOT 2
- new issue
- Placement of defguard? HOT 1
- using pipe with only 2 functions HOT 1
- Pipeline with single pipe operator for common cases like Enum.map/reduce/filter HOT 3
- Nested defmodule HOT 5
- Macro calls placement in a module HOT 1
- Naming: Modules HOT 1
- Clarification on multiline defs HOT 3
- cรณmo utilizamos?
- Racionalfor choice
- Broken Link HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from elixir_style_guide.