r/learnjava • u/Ok_Kaleidoscope2356 • 7d 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

90% Upvoted

7 comments sorted by

•

u/AutoModerator 7d ago

Please ensure that:

  • Your code is properly formatted as code block - see the sidebar (About on mobile) for instructions

  • You include any and all error messages in full - best also formatted as code block

  • You ask clear questions

  • You demonstrate effort in solving your question/problem - plain posting your assignments is forbidden (and such posts will be removed) as is asking for or giving solutions.

If any of the above points is not met, your post can and will be removed without further warning.

Code is to be formatted as code block (old reddit/markdown editor: empty line before the code, each code line indented by 4 spaces, new reddit: https://i.imgur.com/EJ7tqek.png) or linked via an external code hoster, like pastebin.com, github gist, github, bitbucket, gitlab, etc.

Please, do not use triple backticks (```) as they will only render properly on new reddit, not on old reddit.

Code blocks look like this:

public class HelloWorld {

    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

You do not need to repost unless your post has been removed by a moderator. Just use the edit function of reddit to make sure your post complies with the above.

If your post has remained in violation of these rules for a prolonged period of time (at least an hour), a moderator may remove it at their discretion. In this case, they will comment with an explanation on why it has been removed, and you will be required to resubmit the entire post following the proper procedures.

To potential helpers

Please, do not help if any of the above points are not met, rather report the post. We are trying to improve the quality of posts here. In helping people who can't be bothered to comply with the above points, you are doing the community a disservice.

I am a bot, and this action was performed automatically. Please contact the moderators of this subreddit if you have any questions or concerns.

3

u/gimmematcha 7d ago edited 7d 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 7d 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 7d 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.

1

u/Abhistar14 6d ago

Rate this?

1

u/No-Limit-6237 2d ago

Yeah i am beginner and cannot apprecite your project in the way it deserves. But man, went through your readme and it is amazing. Youve got to teach us too man. Amazing work.