search

bjorno43 / NMS-Advanced-Modding-Station

A tool to create mods for the game No Man's Sky
MIT License
4 stars 4 forks source link

Code cleaning #1

Open bjorno43 opened 4 years ago

bjorno43 commented 4 years ago

This project can honestly use a lot of code cleaning. I've decided to allow it to participate in the hacktoberfest event for this as it's not too difficult to do and should therefor be doable by most beginner / intermediate C# developers. For example: Exception handlers can most likely be improved quite a bit.

ceterisp commented 4 years ago

Hi, can I give this a shot?

bjorno43 commented 4 years ago

@abuZayed15 Sure, go right ahead!

ceterisp commented 4 years ago

Thank you @bjorno43 for having me work on this issue. I might have a few questions as I am a beginner in C# so please bear with me :) For starters, is there anything specific you want me to refactor?

Thanks!

bjorno43 commented 4 years ago

@abuZayed15 I would start by looking at all the exceptions. You're going to find a lot of duplicated in there, or very close duplicates (strings repeating themselves). This can most likely be improved by creating some private strings within the class and have them use those instead. That will improve maintainability. Make sure you use logical variable naming and stick to camelCase conventions.

ceterisp commented 3 years ago

@bjorno43 Got it. I will make some changes and raise a PR. If you don't like something or you want me to change a few more things I can always push new commits to the same PR. Thanks for the direction!

ajonestechnology commented 3 years ago

If it's not an issue, I'd also like to contribute to this code cleanup! My goal will be to ensure this project adheres to the SOLID principles as much as possible.

bjorno43 commented 3 years ago

@ajonestechnology Sorry, I've been away for a few days (weekend). You're more than welcome to work on this as well. Just make sure you keep it up to date with merged PRs so there won't be any conflicts. Even if the PRs you submit can't be merged yet due to conflicts, I'll make sure to label them as hacktoberfest-accepted before the end of that event so you at least get that in return for your efforts :)

ajonestechnology commented 3 years ago

@ajonestechnology Sorry, I've been away for a few days (weekend). You're more than welcome to work on this as well. Just make sure you keep it up to date with merged PRs so there won't be any conflicts. Even if the PRs you submit can't be merged yet due to conflicts, I'll make sure to label them as hacktoberfest-accepted before the end of that event so you at least get that in return for your efforts :)

Much appreciated!

sYonashiro commented 3 years ago

@bjorno43 i make a little improvement on code of HelpForm.cs file, can i open a pull request?

bjorno43 commented 3 years ago

@sYonashiro Of course you can :) I'll review it and if it helps, I'll accept it. If not, I'll give you some pointers on how you might be able to improve your PR

sYonashiro commented 3 years ago

9 I make some changes in HelpForm.cs file, hope you like it 👍

bjorno43 commented 3 years ago

@sYonashiro I've reviewed and accepted it. Thanks for your contribution 👍