Skip to content

GP-28 add README.MD #15

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

Merged
merged 1 commit into from
Jan 6, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions 3-0-java-core/src/main/java/com/bobocode/file_reader/README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# <img src="https://raw.githubusercontent.com/bobocode-projects/resources/master/image/logo_transparent_background.png" height=50/>File Reader exercise :muscle:
Improve your Java SE and Clean Code skills
### Task
`FileReaders` is an API that allows you to read whole file content into a `String`. Your job is to
implement the *todo* section of that class.

### Refactoring Task
There is an dirty implementation of class `FileReaders` that **contains bad practices and code smells**. If you want to
practice in **refactoring** and improve your **clean code skills** you can start from branch **exercise/dirty** instead of
**master** and try to refactor existing implementation.

To verify your implementation, run `FileReadersTest.java`

### Pre-conditions :heavy_exclamation_mark:
You're supposed to know how to work with text files and be able to write Java code

### How to start :question:
* Just clone the repository and create a branch **exercise/your_username** if you want your code to be reviewed
* Start implementing the **todo** section and verify your changes by running tests
* If you don't have enough knowledge about this domain, check out the [links below](#related-materials-information_source)
* Don't worry if you got stuck, checkout the **exercise/completed** branch and see the final implementation

### Related materials :information_source:
* [Stream API tutorial](https://github.com/bobocode-projects/java-functional-features-tutorial/tree/master/stream-api)