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

Add use cases in developer guide #231

Merged
merged 9 commits into from
Apr 13, 2024
Merged

Conversation

logical-1985516
Copy link
Collaborator

No description provided.

Copy link

codecov bot commented Apr 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.23%. Comparing base (56bea3b) to head (d0e5d9b).
Report is 27 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@chiralcentre chiralcentre left a 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


* 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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"jib" -> job

Comment on lines 629 to 632
- 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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

can be deleted



* 3c. Recruiter enters invalid vacancy
- 3c1. Hirehub raises an error and asks recruiter to provide phone number in a correct format
Copy link
Collaborator

Choose a reason for hiding this comment

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

phone number -> vacancy

- Use case resumes from step 2.


* 3d. No attributes are provided by recruiter to update in the attribute field
Copy link
Collaborator

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

Comment on lines 660 to 664
* 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.
Copy link
Collaborator

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

Comment on lines 586 to 590
* 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.
Copy link
Collaborator

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 Show resolved Hide resolved

* 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
Copy link
Collaborator

Choose a reason for hiding this comment

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

incomplete sentence

Comment on lines 786 to 789
- 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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

can be deleted


* 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.
Copy link
Collaborator

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

logical-1985516 and others added 6 commits April 14, 2024 03:12
Since index may be a non-number - this covers the case where the
recruiter types non-numbers for index (which would raise an error)
Copy link
Collaborator

@chiralcentre chiralcentre left a comment

Choose a reason for hiding this comment

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

LGTM

@chiralcentre chiralcentre added this to the v1.4 milestone Apr 13, 2024
@chiralcentre chiralcentre linked an issue Apr 13, 2024 that may be closed by this pull request
@chiralcentre chiralcentre merged commit 1676a83 into master Apr 13, 2024
8 checks passed
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.

add use cases for DG
2 participants