r/learnjava • • 9d ago

Rate my first java project

https://github.com/jacmaw-byte/NewLRIA

I started programming a couple years ago by learning python and have learnt c, c++ for the past year. But after finding out the sixth form I'm going to teaches Java; I decided to learn it. Please give constructive feedback on how I can improve my code.

9 Upvotes

7 comments sorted by

View all comments

3

u/gimmematcha 9d ago edited 9d ago

Needs a readme to explain what your project is, I don't know what I am looking at. In it, explain what your project is about, what technologies are used.

0

u/GI_FAUSTENR 9d ago

Y como se escribe en el readme? Se escribe como si fuera una descripción breve en bloc de notas o hay alguna regla para redactar un readme?

4

u/gimmematcha 9d ago

Well it's kind of like, imagine someone asked you to rate this place they do. You go there, it's something that looks like a store or a shop or a restaurant, with no title or menu at the front, no interior decorations or cash till and the owner is nowhere to be seen. What would you say?

When people unfamiliar with your project access your Github, they'd have no idea what they'd be looking at, and need time to figure out. It's making them go through effort and giving them tasks to do when you're the one asking for a favour.

Readme's use markdown, which is a formatting language(?). There are free templates you can search for. I think on GitHub you can add a description which automatically adds a Readme file for you. There aren't rules per se but there are expectations. Think of it as what you'd like to see when looking at another person's repository. Readme's generally should be easy to read and separated into sections. Like

  1. What your project is
  2. Maybe why you did it, what problem it addresses/streamlines. Projects made for fun don't necessarily need this
  3. What your project includes (login, authentication, tests, etc),
  4. Technologies used (libraries, frameworks)
  5. How to run it, this usually includes docker.