-
Notifications
You must be signed in to change notification settings - Fork 2
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
Coding style conventions #2
Comments
Good idea. Let s follow the meteor guide style https://github.com/meteor/meteor/wiki/Meteor-Style-Guide Le 19 juil. 2014 à 10:16, Gilles Fabio notifications@github.com a écrit : Some files are indented with tabs, some with spaces, some with a mix of — |
Yes, Meteor-Style-Guide is great! I have updated the wiki. Let's write our conventions there when something is different than the Official Meteor Style Guide.
|
|
Okay, I agree, let's make it a learning base for newcomers: JavaScript and pure HTML sound good. If we could use SASS that would be great, but I can adapt if people prefer SCSS or LESS. |
I confess, I have some love for SASS too. Maybe we could vote? Nine contributors. Ten watchers. That would be great to have their opinion. ping @acemtp @fabien-h @adrienjoly @Guillaume-dev @williamledoux @davidbourguignon @xgorse @dadge @pinouchon |
I never used sass. If you think that it's very common to use in the meteor world, and if it's easy to migrate our code, I'm ok with it. Adrien Joly (mobile)
|
@adrienjoly Thanks. Honestly, I don't know if it's very common in the Meteor ecosystem. Just saw it's already in use on the project and has some love. And what about JS vs CoffeeScript? |
I vote against coffeescript because meteor is javascript based and coffeescript is not javascript anymore => people that are not comfortable with Cs will not be able to understand the meteor project's code => we would not satisfy our goal of sharing a project for learning purposes (or at least it would not target beginners anymore) Adrien Joly (mobile)
|
@adrienjoly Thanks. I agree. |
Actually, you don't have to use sass or to migrate existing code if other people are using it in the project. Because when using the scss version, the basic css syntax is valid. In your scss files, you can write this :
Or this :
The first block will be converted into the second and the second won't be touched. Both are valid and can follow any style guide you want. But honestly, sass without compas... The question is more : does the designer wants sass ? Like the bootstrap use, it's not good or bad, it's relevant or not depending on the organisation. Coffe / js does the same thing. But any coffee user wille be confortable with js. All the js users are not confortable with coffee. |
Sent from mobile so I ll be short. This app could be a cool app that new people could learn. So: 1/ it should stay in JavaScript CSS HTML. Even if I really like sass jade 2/ it would be nice to have one directory per module (jobs/ meetup/ Le 20 juil. 2014 à 11:00, fabien huet notifications@github.com a écrit : Actually, you don't have to use sass or to migrate existing code if other In your scss files, you can write this : body{color: #333; Or this : body{color: #333;} The first block will be converted into the second and the second won't be But honestly, sass without compas... The question is more : does the designer wants sass ? Like the bootstrap Coffe / js does the same thing. But any coffee user wille be confortable — |
I agree for SASS. Kind of overkill? So let's stay HTML/CSS/JS? Everyone agrees? @acemtp, could you tell us more about the "one directory per module"?
Like that? The
Here, |
HTML/CSS/JS for now yes. Less is more. client/jobs/ With so small projects like this one, I really fed up to have to click on 5 jobs/jobs.js until the files are < 200 lines is completely OK. New people can just open Vianney Lecroart Website http://www.ploki.info | Blog http:/blog.ploki.info | PS: I welcome VSRE http://vsre.info/ emails! On Sun, Jul 20, 2014 at 1:35 PM, Gilles Fabio notifications@github.com
|
I honestly think that while a specific module fits in one file of each type, we could get rid of the folder, and add the folder once it's needed. client/meetups.html |
+1 william Vianney Lecroart Website http://www.ploki.info | Blog http:/blog.ploki.info | PS: I welcome VSRE http://vsre.info/ emails! On Sun, Jul 20, 2014 at 6:16 PM, William Ledoux notifications@github.com
|
That's not a LOC or number of files issue. Both approaches have the same amount. It's contextual. Having modules at the same level of everything else in
Or even worse:
I'm sorry but I just think "what a mess! bye bye!". Now, if I add a single one directory named
I can instantly understand the project. If I'm a newcomer coming from Django, Rails, Symfony, Express or any other framework, this structure sounds familiar to me. "Views"? Oh well, I know. When you learn a new technology, having landmarks can help a lot. @acemtp @williamledoux guys, keep in mind that you're building a project that mainly targets newcomers. Please please, help them to love Meteor. Less is more when you master the tool. |
As a newcomer, I really prefer to see something like: jobs/client.js So if i want to understand how jobs are working on the project, I know And if they want familiar structure, they just can go and see telescope :) Vianney Lecroart Website http://www.ploki.info | Blog http:/blog.ploki.info | PS: I welcome VSRE http://vsre.info/ emails! On Sun, Jul 20, 2014 at 6:29 PM, Gilles Fabio notifications@github.com
|
Some files are indented with tabs, some with spaces, some with a mix of both... Please, add a
CONTRIBUTING
file or Contributing section in README with coding style conventions to use and EditorConfig support.The text was updated successfully, but these errors were encountered: