-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add use cases in developer guide #231
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #231 +/- ##
=========================================
Coverage 55.23% 55.23%
Complexity 587 587
=========================================
Files 125 125
Lines 2714 2714
Branches 328 328
=========================================
Hits 1499 1499
Misses 1132 1132
Partials 83 83 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fix the following nits
docs/DeveloperGuide.md
Outdated
|
||
* 2b. Recruiter enters invalid vacancy | ||
- 2b1. Hirehub raises an error and asks recruiter to provide valid vacancy. | ||
- 2b2. Recruiter attempts to add the jib with valid vacancy. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"jib" -> job
docs/DeveloperGuide.md
Outdated
- 4a2. Recruiter re-attempts to delete the job | ||
- Use case 4a is repeated if the recruiter cancels the deletion again. | ||
- If the recruiter enters invalid job number, the use case resumes from 2a. | ||
- Use case resumes from step 4. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can be deleted
docs/DeveloperGuide.md
Outdated
|
||
|
||
* 3c. Recruiter enters invalid vacancy | ||
- 3c1. Hirehub raises an error and asks recruiter to provide phone number in a correct format |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
phone number -> vacancy
docs/DeveloperGuide.md
Outdated
- Use case resumes from step 2. | ||
|
||
|
||
* 3d. No attributes are provided by recruiter to update in the attribute field |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can remove the last four words
docs/DeveloperGuide.md
Outdated
* 3a. Recruiter enters invalid job number that is not a positive integer | ||
- 3a1. Hirehub raises an error and asks recruiter to provide a valid job number. | ||
- 3a2. Recruiter attempts to edit the job with a valid job number. | ||
- Steps 3a1-3a2 are repeated until the job number entered is correct. | ||
- Use case resumes from step 2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
everything should be from step 2
docs/DeveloperGuide.md
Outdated
* 2a. Recruiter enters invalid job title | ||
- 2a1. Hirehub raises an error and asks recruiter to provide valid job title. | ||
- 2a2. Recruiter attempts to add the job with valid job title. | ||
- Steps 2a1-2a2 are repeated until the email address entered is in a correct format. | ||
- Use case resumes from step 2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
everything should be step 1
docs/DeveloperGuide.md
Outdated
|
||
* 3f. Recruiter enters a vacancy that is fewer than the current number of OFFERED applications to the job | ||
- 3f1. Hirehub raises an error and asks the recruiter to provide a larger vacancy. | ||
- 3f2. Recruiter attempts to edit the job with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
incomplete sentence
docs/DeveloperGuide.md
Outdated
- 4a2. Recruiter re-attempts to delete the application | ||
- Use case 4a is repeated if the recruiter cancels the deletion again. | ||
- If the recruiter enters invalid application number, the use case resumes from 2a. | ||
- Use case resumes from step 4. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can be deleted
docs/DeveloperGuide.md
Outdated
|
||
* 2e. Recruiter enters a job title that is not in the job list | ||
- 2e1. Hirehub raises an error and asks recruiter to provide a job title that is in the list. | ||
- 2e2. Recruiter attempts to add the application to an existing job with an existing job title. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Last five words not required
Since index may be a non-number - this covers the case where the recruiter types non-numbers for index (which would raise an error)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.