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.

Sign up for GitHub

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

Jump to bottom

Improve README documentation #61

Merged
merged 8 commits into from
Aug 16, 2023
Merged

Improve README documentation #61

merged 8 commits into from
Aug 16, 2023

Conversation

aricasas
Copy link
Contributor

@aricasas aricasas commented Aug 14, 2023 •
edited
Loading

This PR will add to and improve our README documentation, mostly concerning feedback received from Milestone 4 from our TA

@aricasas aricasas self-assigned this Aug 14, 2023
@aricasas aricasas added the documentation Improvements or additions to documentation label Aug 14, 2023
@aricasas aricasas linked an issue Aug 14, 2023 that may be closed by this pull request
Improve README.md documentation #49
Closed
katarinaavucic
katarinaavucic requested changes Aug 14, 2023
View reviewed changes
Copy link
Contributor

@katarinaavucic katarinaavucic left a comment

Choose a reason for hiding this comment

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

It looks super good and very professional! My only comment is on the design pattern section! :)

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@katarinaavucic
Copy link
Contributor

I just realized that we will need to redo the Javadocs and Code Coverage reports after Lulu pushes her PR.

katarinaavucic
katarinaavucic reviewed Aug 14, 2023
View reviewed changes
Copy link
Contributor

@katarinaavucic katarinaavucic left a comment

Choose a reason for hiding this comment

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

I will approve once we update the Javadoc and coverage report (I have added myself to the coverage issue so I will do that as soon as Lulu's PR is merged)!

README.md Show resolved Hide resolved
@aricasas
Copy link
Contributor Author

Sounds good! For this one, the only thing that needs to change is the test coverage screenshot, so we only need to wait for that PR

@aricasas
Moved Code Structure (used to be Implementation), Testing and JavaDoc…
969b967 
… subsections into a new section called Implementation
YinLingithub
YinLingithub previously approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@YinLingithub YinLingithub left a comment

Choose a reason for hiding this comment

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

Looks great!

katarinaavucic
katarinaavucic previously approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@katarinaavucic katarinaavucic left a comment

Choose a reason for hiding this comment

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

Looks perfect!!!

YinLingithub
YinLingithub previously approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@YinLingithub YinLingithub left a comment

Choose a reason for hiding this comment

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

Looks great!

luluwuwu
luluwuwu previously approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@luluwuwu luluwuwu left a comment

Choose a reason for hiding this comment

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

great!

katarinaavucic
katarinaavucic approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@katarinaavucic katarinaavucic left a comment

Choose a reason for hiding this comment

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

Yay!

luluwuwu
luluwuwu approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@luluwuwu luluwuwu left a comment

Choose a reason for hiding this comment

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

approved

YinLingithub
YinLingithub approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@YinLingithub YinLingithub left a comment

Choose a reason for hiding this comment

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

Approving again.

@aricasas aricasas merged commit 21a467c into main Aug 16, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@katarinaavucic katarinaavucic katarinaavucic approved these changes

@luluwuwu luluwuwu luluwuwu approved these changes

@YinLingithub YinLingithub YinLingithub approved these changes

Assignees

@aricasas aricasas

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve README.md documentation
4 participants
@aricasas @katarinaavucic @luluwuwu @YinLingithub