Update .README for take home test #6
Conversation
- more clearly set out requirements - state what good looks like - trim down some large areas of text - remove .NET and Java specific instructions (to be moved out into their own README in each language file
franbromley
requested review from
philwills,
jaf-Accurx,
nickljones and
jimbo-accurx
README.md
Outdated
|
|
||
| A test project is included (with JUnit added though can be swapped for an alternative) if Unit tests are wanted. There is also an App Main function which has a real Accurx URL (which **DOES** support partial content) and an example of a file path so that the code can be tested for real. | ||
|
|
||
| ## Tips | ||
|
|
||
| - Take the time to read through the task and description. There's guidance in there that can be helpful to approaching the problem. | ||
| - The code doesn't need to be perfect but it needs to be readable. |
There was a problem hiding this comment.
If we're modifying the README - i'd personally like to remove this line
(let the candidate determine what quality code they're happy to submit)
There was a problem hiding this comment.
Good suggestion Jimbo - thanks! removed
README.md
Outdated
| A high-quality submission will have the following: | ||
| - Meet the requirements above | ||
| - Appropriate use of language features to solve the problem in a neat and simple way | ||
| - Well structured code |
There was a problem hiding this comment.
What does well-structured code look like? Can we be more specific about the things we're looking for here?
There was a problem hiding this comment.
I think we're looking for code that is easy to read and reason about. Typically using software design principles like SOLID.
There was a problem hiding this comment.
Thanks Jaf! I've made an update based on this - really helpful!
README.md
Outdated
| A high-quality submission will have the following: | ||
| - Meet the requirements above | ||
| - Appropriate use of language features to solve the problem in a neat and simple way | ||
| - Well structured code |
There was a problem hiding this comment.
I think we're looking for code that is easy to read and reason about. Typically using software design principles like SOLID.
README.md
Outdated
|
|
||
| ### Java | ||
| 1. The installer downloads in the following scenarios: | ||
| - When internet disconnections occur (we use 2 minutes as a disconnection time benchmark for this) |
There was a problem hiding this comment.
Is there a reason we're avoiding the word "timeout" here?
There was a problem hiding this comment.
Agree this is pretty ambiguous language. I've replaced with the following
- The download is successful if the internet connection is lost for up to two minutes
- The downloader should timeout if the internet connection is lost for more than two minutes
README.md
Outdated
|
|
||
| The purpose of this exercise is for us to learn about how you analyse requirements, solve problems, use language features appropriately, structure code, and verify your solution works correctly. These are the main factors we take into account when assessing your solution. | ||
| ### What is expected of you? | ||
| 1. Please complete the task detailed below👇 |
There was a problem hiding this comment.
This feels odd to have a numbered point, but I get the intent and don't have a great alternative suggestion.
There was a problem hiding this comment.
Updated to use bold type instead
remove suggestion of adding unit tests - we would like to see these! Co-authored-by: Phil Wills <[email protected]>
Remove optionality from tests Co-authored-by: Phil Wills <[email protected]>
remove unnecessary drivel - let's get to the point ;) Co-authored-by: Phil Wills <[email protected]>
Remove specific library mentions Co-authored-by: Phil Wills <[email protected]>
Remove numbering and use bolding instead
Make clearer expectations on timeouts
Co-authored-by: Phil Wills <[email protected]>
Just decide if you want full stops or not Fran
Motivation
There has been a trend of submissions for the take-home not meeting the requirements of the marking scheme.
In line with our other interview rounds, we aim to be as clear and transparent as possible with the expectations of the interview rounds and set them up for success. The aim of this PR is to see if making the requirements of the take-home clearer to candidates will increase the number of submissions that meet the core requirements
Key changes