Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Architectural Changes #82

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Architectural Changes #82

wants to merge 3 commits into from

Conversation

chrisc96
Copy link

Hello,
As part of one of my papers at University we were asked to select an open source project to improve. I decided on yours. Apologies for the size of the changes. I've added some documentation here in the 'what I've changed' folder to try explain things a bit better.

Essentially my changes were about redesigning the system to be more flexible and extensible in case of future requirements change. It should make the usage of the command line much simpler while still working in the same way. It also 'fails faster' by adding much better validation on the command line arguments, and also begins to use more design patterns.

I'm not saying my changes are incredible, lord knows they're not - I'm still at uni for peats sake, but this is my first pull request so that's exciting!

Thanks :)

@nicolas-raoul
Copy link
Collaborator

Thanks for you interest in the project!
It is unfortunate that you decided to reformat all the code (spaces, new lines, etc) within the same pull request: it makes the real changes much harder to spot.
I will try to make sense of the 85 changed files though :-)

FileUtils.createDirectory(fileNames.getWorkingDir());
}
System.out.println();
System.out.println("CHRIS CONNOLLY RUNNING THIS");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you forgot to remove this?

Copy link
Author

@chrisc96 chrisc96 Jul 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, sorry. Apologies for my naivety but once I've made the changes in my forked repo, do I need to submit another PR or does this one auto update?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just push a new commit to the same branch and it will magically be added to your PR :-)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the same branch" = master for you. By the way, the usual workflow in open source is this: 1) Post an issue describing a specific problem and how you will solve it 2) Create a branch with a name that refers to this issue and fixes only that specific issue 3) Send pull request. You can do this for several issues in parallel, and the maintainers can decide what issues are real issues or non-issues, and prioritize what branch to review and pull first.
Cheers!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for that information. I've dealt with issues on Kanban boards etc but working with open source is new to me :) Cheers!

@chrisc96
Copy link
Author

Yeah sorry about that. I didn't actually think I was going to make a PR when I did the project but I figured I may as-well. Sorry for the extra work that will require.

@chrisc96
Copy link
Author

Might I recommend when considering this that you go to 'diff settings' and 'hide whitespace changes'. This should make the review process a lot easier to view.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants