Github opinions

  • (2 Pages)
  • +
  • 1
  • 2

15 Replies - 735 Views - Last Post: 06 November 2019 - 08:27 PM Rate Topic: -----

#1 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Github opinions

Posted 24 October 2019 - 06:52 PM

Hey, I am looking to get a junior dev job hopefully in the near future and was curious if anyone would be open to giving me feedback on my Github. It's a little messy and unorganized right now so I have to clean that up. But if anyone would be interested in giving me feedback, ideas of what to include, or just downright roast me that would be appreciated! :bigsmile:/>

GITHUBBBBBBBBBBBB

Is This A Good Question/Topic? 0
  • +

Replies To: Github opinions

#2 modi123_1   User is offline

  • Suitor #2
  • member icon



Reputation: 15361
  • View blog
  • Posts: 61,605
  • Joined: 12-June 08

Re: Github opinions

Posted 24 October 2019 - 07:08 PM

Not a whole lot there.
Nothing is explained.
No project information or about.
The code is a 'meh'.
Was This Post Helpful? 1
  • +
  • -

#3 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Re: Github opinions

Posted 24 October 2019 - 07:14 PM

A meh is better than absolute garbage though. I didn't really think to add comments to explain what things do though..... I'll do that. Thank you!
Was This Post Helpful? 0
  • +
  • -

#4 jon.kiparsky   User is offline

  • Beginner
  • member icon


Reputation: 11689
  • View blog
  • Posts: 19,870
  • Joined: 19-March 11

Re: Github opinions

Posted 24 October 2019 - 09:09 PM

Start with a README, and then work your way down from there.
Was This Post Helpful? 1
  • +
  • -

#5 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Re: Github opinions

Posted 24 October 2019 - 09:16 PM

View Postjon.kiparsky, on 24 October 2019 - 09:09 PM, said:

Start with a README, and then work your way down from there.


Do you mean put a readme at the beginning of the code and then add comments down?

or is this a roast?
Was This Post Helpful? 0
  • +
  • -

#6 modi123_1   User is offline

  • Suitor #2
  • member icon



Reputation: 15361
  • View blog
  • Posts: 61,605
  • Joined: 12-June 08

Re: Github opinions

Posted 24 October 2019 - 09:16 PM

No, a readme for your repo.
Was This Post Helpful? 1
  • +
  • -

#7 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Re: Github opinions

Posted 24 October 2019 - 09:17 PM

Roger that.
Was This Post Helpful? 0
  • +
  • -

#8 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Re: Github opinions

Posted 24 October 2019 - 09:31 PM

modi123_1, what do you think of the morse code translator?
Was This Post Helpful? 0
  • +
  • -

#9 baavgai   User is offline

  • Dreaming Coder
  • member icon


Reputation: 7501
  • View blog
  • Posts: 15,544
  • Joined: 16-October 07

Re: Github opinions

Posted 25 October 2019 - 02:35 AM

View Postlolwtfdemon, on 25 October 2019 - 12:31 AM, said:

what do you think of the morse code translator?

I didn't see a "morse code translator." I'm assuming it's in one of the undescriptively named repos? Begin with a read me.

Oh, wait, found it: https://github.com/t...morse_decode.py

This tells you what to do next: your read me should describe each of the scripts and what they show off.

As to the code... include in that read me how to use it. Also, wrangle all that global space code into a main. Provide example usage and maybe example data.

The giant if/then fills me with fear. Can it be a dict? The values 'boop' and 'hold' are practically magic. Rather than use strings throughout the code, prefer a couple constants.

The craigs_email looked like fun. I did a quick refactor of it:
Spoiler


Good luck.
Was This Post Helpful? 0
  • +
  • -

#10 astonecipher   User is offline

  • Senior Systems Engineer
  • member icon

Reputation: 3000
  • View blog
  • Posts: 11,549
  • Joined: 03-December 12

Re: Github opinions

Posted 25 October 2019 - 07:45 AM

Multiple repo's rather than cramming them into as few as possible. A project is a repo in your case. Add somethings that make them more showy to highlight things. Everything is incredibly simple with no complexity at all. Do something that really interests you and add to it incrementally. Include unit testing and multiple branches that show you know other facets of development. Coding for a company is more than just the code itself, using a VCS is part of that, so utilize it more than just for a bulk upload bin.
Was This Post Helpful? 0
  • +
  • -

#11 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Re: Github opinions

Posted 25 October 2019 - 06:34 PM

I really appreciate that feed back! Yeah I was messing around when I was looking to get a mk4 Jetta lol. I was thinking about going back to redo that one and clean it up. I like what you did with it.

Yes, I have a new version of the morse code program that works better and using a dict instead of that god awful if statement. What do you mean prefer a couple constants?





View Postbaavgai, on 25 October 2019 - 02:35 AM, said:

View Postlolwtfdemon, on 25 October 2019 - 12:31 AM, said:

what do you think of the morse code translator?

I didn't see a "morse code translator." I'm assuming it's in one of the undescriptively named repos? Begin with a read me.

Oh, wait, found it: https://github.com/t...morse_decode.py

This tells you what to do next: your read me should describe each of the scripts and what they show off.

As to the code... include in that read me how to use it. Also, wrangle all that global space code into a main. Provide example usage and maybe example data.

The giant if/then fills me with fear. Can it be a dict? The values 'boop' and 'hold' are practically magic. Rather than use strings throughout the code, prefer a couple constants.

The craigs_email looked like fun. I did a quick refactor of it:
Spoiler


Good luck.


I would agree with you that everything in there is pretty simple (except for maybe the morse code one...). But sadly I only really have my imagination to go off of and google currently. Do you have any ideas for cool complex problems I could take a swing at?


View Postastonecipher, on 25 October 2019 - 07:45 AM, said:

Multiple repo's rather than cramming them into as few as possible. A project is a repo in your case. Add somethings that make them more showy to highlight things. Everything is incredibly simple with no complexity at all. Do something that really interests you and add to it incrementally. Include unit testing and multiple branches that show you know other facets of development. Coding for a company is more than just the code itself, using a VCS is part of that, so utilize it more than just for a bulk upload bin.

Was This Post Helpful? 0
  • +
  • -

#12 astonecipher   User is offline

  • Senior Systems Engineer
  • member icon

Reputation: 3000
  • View blog
  • Posts: 11,549
  • Joined: 03-December 12

Re: Github opinions

Posted 25 October 2019 - 06:49 PM

It comes done to personal interests. You could do a POS system for a restaurant or grocery store; Martyr has an idea book of projects if you really get stuck, but find what you have an interest in and start a project on it.


I wrote a medication reminder once for a friend that just reminded the family when medication needed to be doled out, what it was, the dosage, all configurable based on what the doctor said was need.
Was This Post Helpful? 0
  • +
  • -

#13 lolwtfdemon   User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 17
  • Joined: 29-January 19

Re: Github opinions

Posted 25 October 2019 - 06:57 PM

That's a cool idea. I'll check out that book tomorrow and see if I can pick a few and work on those. Like I said I really appreciate the feedback and the tips! I don't have any friends with an interest in programming in general so it's nice to get feed back.

I made a little POS system in Java for a class so maybe I'll post that in there as well.


View Postastonecipher, on 25 October 2019 - 06:49 PM, said:

It comes done to personal interests. You could do a POS system for a restaurant or grocery store; Martyr has an idea book of projects if you really get stuck, but find what you have an interest in and start a project on it.


I wrote a medication reminder once for a friend that just reminded the family when medication needed to be doled out, what it was, the dosage, all configurable based on what the doctor said was need.

Was This Post Helpful? 0
  • +
  • -

#14 baavgai   User is offline

  • Dreaming Coder
  • member icon


Reputation: 7501
  • View blog
  • Posts: 15,544
  • Joined: 16-October 07

Re: Github opinions

Posted 26 October 2019 - 08:12 AM

View Postlolwtfdemon, on 25 October 2019 - 09:34 PM, said:

What do you mean prefer a couple constants?

Numbers and strings in code are sometimes called magic. This has a few issues. One is simply "why the hell did they use X here," Hence the magic. However, just as importantly, is the ability to fat finger things.

If you use 'fizz' and 'buzz' in your code, there's a non zero chance that, at some point, you'll type 'fiz' or 'buz'. Since it's a string, your compiler don't care and finding that bug will cause hair loss. Instead, if you define FIZZ, BUZZ = 'fizz', 'buzz' and reference those constants consistently, a typo will be caught much earlier. Further, in the future, if 'fizz' becomes 'fiz' you need only change the value of the constant and leave the rest of your code alone.

Constants are basically the shortest expression of DRY.
Was This Post Helpful? 0
  • +
  • -

#15 ndc85430   User is offline

  • I think you'll find it's "Dr"
  • member icon

Reputation: 981
  • View blog
  • Posts: 3,871
  • Joined: 13-June 14

Re: Github opinions

Posted 26 October 2019 - 08:49 AM

Write some automated tests (e.g. unit tests) ;). Python comes with its own test framework, unittest and there are also third party ones like pytest.
Was This Post Helpful? 0
  • +
  • -

  • (2 Pages)
  • +
  • 1
  • 2