Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Meta

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Comments on Should I post a link to the Github repo for code reviews?

Parent

Should I post a link to the Github repo for code reviews?

+6
−0

Hello. Total noob here and noob to this site. I've written a non-trivial program in Python. Code review didn't take the whole thing (400+ lines of code). Should I post a link to my Github repo or is that not appropriate?

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.
Why should this post be closed?

0 comment threads

Post
+5
−0

Welcome!

It's best if the code being reviewed is here on the site, for ease of reference and defense against link rot. That sounds like a sizable program; are there key parts you'd like review on, as opposed to the whole thing? You could include the GitHub link for anybody who wants to run it as part of the review, but most of our code reviews have focused on smaller pieces. The various utility methods, accessors, etc probably aren't the interesting part, right? Also, if you focus on the most important parts, you're more likely to get good feedback from reviewers, as you'll make it easy for them to skip the routine stuff and focus on the meat.

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.

1 comment thread

400 LoC isn't much (5 comments)
400 LoC isn't much
Lundin‭ wrote over 2 years ago

Seriously, 400 lines of code is not much, the average source file is some 200-1000 LoC and a medium-sized project has maybe 50 such files. Sure, a whole project like that would be too much, but why wouldn't the site be able to take a 400 LoC post?

Monica Cellio‭ wrote over 2 years ago

I guess it depends what the 400 lines contain. :-) I would personally skip boilerplate stuff to help readers focus on the important parts, but that might be a matter of formatting. It sounds like the asker might have run into an overall limit on post size; I'm not sure what that is, but I think 30,000 characters maybe? I'll have to check.

Lundin‭ wrote over 2 years ago

Monica Cellio‭ Well 400 lines of very compact and detailed code with lots of comments might go as far as 30k characters... maybe. If we are looking for some worst-case number, I'd say a reasonable upper limit might be something like 1k lines 80 characters each = 80k. Larger than that and it won't be fun to review for sure. 1k lines isn't unreasonable but 80k characters might be - code lines are usually not that long even in the most verbose languages like Java.

Zakk‭ wrote over 2 years ago

Lundin‭ What about a minimal reproducible example?

Lundin‭ wrote over 2 years ago

Zakk‭ This is about the code review category of this site so it doesn't apply.