Performing Jobs
From Shadowrun: Awakened
The following document outlines the procedure to complete a job filed in the Job Tracker. For a procedure to file a Job, check the wiki page on How to submit a job.
The first step is finding which jobs have been filed and are available. Go to the Job Tracker page, and log in. Once you're logged in, you will find a list of all jobs and their status, unless you have a filter active. If you do, then you will only see the jobs that meet your filter criteria.
What you can do with a job depends on its status.
Contents |
Unassigned
These are the jobs that have been submitted, but have not yet been assigned to anyone. You can review the job, and if you believe you can complete it under the timeframe specified, then you can assign the job to yourself and get cracking.
Assigned
These are the jobs that have been assigned to a particular member. If you have a job assigned to you, it can be because of two reasons:
- You assigned the job to yourself: No question about that.
- A Lead Programmer assigned the job to you: This means that either the Lead Programmer has spoken with you already, or that he feels confident you can complete the job at hand.
Regardless of how you got the job, the first step would be to document yourself. Read the job description, and if you have any doubts take them to the Lead Programmer. Once you are absolutely clear on what needs to be done, start performing the job. How to perform the job can depend on the nature of it.
Asset Jobs
If your job is related to Assets, how you complete the job will depend on what type of asset you are working with. Regardless of the type, follow the Asset Submission Guidelines and select the appropriate file type for your asset.
Once you have completed the job, you must submit it to the Assets Manager. Once it is received by the Assets Manager and no changes are necessary, you can change the status to Completed. Since assets rarely need testing, it is safe to say that your job is done (pardon the pun).
Programming jobs
If your job is related to programming, there's no right way or wrong way to complete it, but you should abide by the following rules:
- Follow the Coding Standard
- Follow the Quality Assurance guidelines for programming.
- Understand that the feature you're currently working on is part of a bigger project, therefore, make sure that it can seamlessly be merged into the rest of the project.
Once you have completed your job, you have to do the basic testing of it. since you are the person that programmed it, you are in the best position to know the inner workings of your code, therefore it is important to test it as thoroughly as possible. Use the Test Plan outlined in the Job Description as a guide, and if you have further doubts, contact QA.
Once you have completed basic testing, and have fixed any possible bug you found during this process, you can finally Submit your code. Once the code has been successfully submitted, you can add a followup comment explaining how you completed the job, and you can change the status to Completed.
Completed
These are the jobs that have been completed, but have not yet been tested. Quality Assurance will proceed to test the feature. There are two objectives for this testing:
- The main objective is to verify that the feature does what it is supposed to do. If the feature does not cover the requirements listed, then it will be returned to the programmer, with a followup comment explaining why it was returned.
- The secondary objective, once functionality has been verified, is to find bugs in the feature.
Once functionality is verified by Quality Assurance, the status will be changed to Verified.
Verified
There are the jobs that have been tested for functionality, and now need to be tested for bugs. As a QA rule of the project, we have established that bug testing will not be assigned to a specific member, as we would rather see testing done by several users. Read the job description and followup comments, and acting as maliciously as possible, try to crash the feature by whatever means necessary. It is important to try and break the program at this point, as being benevolent towards a fellow member would only hurt the game. Players won’t be as forgiving as you are.
If you find a bug, file it in the Bug Tracker. Read the wiki on Reporting Bugs if you have any questions.
If you are not able to find a bug, it does not necessarily mean that there are no bugs; it means you were not able to find one. Please add a followup comment explaining what you did, how many tests you performed, what type of tests you performed, and how you were unable to reproduce the bug. Once enough members have done the testing, Quality Assurance will move the status to Closed.
Closed
These are the jobs that have been completed, tested, and found working properly. Nothing to see here, move along.
See Also
