https://github.com/discourse/discourse Background I was trying to customize Discourse. (deep customization, theme/plugin is not enough, not a simple facelift change(logo, color, image etc)) I git clone to my laptop and start reading the code. (I am Ruby on Rails dev & newbie Ember.js dev) Question Why there are so little code comment in codebase? (controller / model / view / etc, both Rails and Ember) I get the phrase “good code itself is comment” (or something like that) But why so little? Thanks.

Because comments tend to rot and deprecate which makes them useless (and sometimes counter intuitive) over time.

I hope you guys(Discourse core team) can write few post about the big picture view on Discourse codebase.. (not like “why chose Ember.js” I already read that one. deeper than that) like: Why this folder structure(Ruby on Rails & Ember.js put together) I guess if you guys make Discourse from scratch in 2018, would decide separated Rails&Ember into 2 repo? or different folder structure What’s the different between GlobalSetting & SiteSetting? What’s the core model of Discourse? (Users&Post&Topic)? why preload_script is needed? example preload_script return # ... some other code ".html_safe so it’s for SEO or some other reason? and few other question I couldn’t recall right now

[image] 1c7: deep customization, theme/plugin is not enough [image]Creating a gender limited forum? In Discourse a plugin can do almost anything :sparkles: You can/should use plugin.

OK, I would read more into plugin. Thanks for the suggestion Vinoth Kannan

Unless you have a team of full time programmers or want never to take advantage of future upgrades to discourse, you want a plugin. Those who have forked are all sorry. Almost anything can be accomplished with a plugin.

Got it, Thanks! we do want future upgrade, would look into Theme and Plugin. Thanks for reply!

Why so little code comment in Discourse Codebase? (Github)

Development

1c7 (Cheng Zheng) April 19, 2018, 10:43am 3

Thanks for reply

But 1-4 line comment per-controller/view/template/etc seem like reasonable number.
not too much, not too little

Topic		Replies	Views
Learn how to start building stuff for Discourse if you're newbie (like myself) Developers explanation	14	30612	October 15, 2023
Some basic questions about discourse and rails Development	3	2094	July 29, 2017
Installed Discourse. Need help understanding code structure Development	2	2272	January 19, 2017
Developer wanted for Discourse customization! Marketplace	1	859	May 16, 2019
Embed Discourse comments with on-page commenting? Feature	32	8593	January 19, 2019

Why so little code comment in Discourse Codebase? (Github)

Related topics