Development Task

Feature Design (10 Mins):

Task Notes

User Story

Define Task

US Review

Feature Design Review

Development (1-3 days):

Module Setup

Module Review

Dev Setup

Dev Review

Unit Testing

Development

Review Information

Review (1 day):

For Reviewer

Final Merge

Client Deliverable

Client Signoff

Final Review

Feature Design (10 Mins):

Feature design is the first phase a task goes through. This task has a few high level tasks:

Task Notes: These are high level notes, usually from Asana, about the task
The User Story is a detailed user-focused explanation of the feature
US Review is where your manager will review your user story
Define Task: This is where you describe exactly what needs to be built. A good task description satisfies the user goal and implements the user story.
Feature Design Review: Your manager will review (1-4) and give you feedback.

It is very important that no work is completed on the task before 1-5 are completed.

Task Notes

Define the task and any rough notes outlining the task.

User Story

Who is the user?

What does the user want in life? What is the big picture goal?

What kinds of things can we do to make their life easier?

The purpose of a user story is to talk about the goal of this task from the users perspective. Below major parts of a task will be explained.

Create a User Script / Procedure (This will be your acceptance criteria)

Example:

A user will git clone or otherwise download the roughNotebooks repository
A user will run all the setup steps in the readme.md, and the test.py
A user will open a notebook in the roughNotebooks directory called 'linearProcessingNetwork.ipynb'
A user will press run on a number of cells:
- One cell will show how to make a new linear regression network
- One cell will show how to train on training data
- One cell will show how to use the linear regression network as a class (facade)
The user is now able to use linear regression in their own projects with no additional training

User Script

After The User story is written, show that it is ready for review by placing a check mark in user story.

Define Task

Now that the user story has been completed, it can be designed. In the design phase we actually write out a description of what will be delivered to the end user.

Describe the deliverable, what you will make, for the end user. Example

They will visit a website
- There will be a header section with a picture of the team.
- ...
- The sign up button will send them a welcome email
- ...
- ..
- ..

Write out the feature design here

What format will the deliverable / task be in. Type a description or link an example of this format below (example excel sheet, doc file)

Is a new module required for this task?

Is a Unit Test Required for this task?

Will this task be delivered to a client?

What kind of task is this?

1

Feature Design is complete

US Review

At this point you must review the user story to ensure it meets a minimum standard. Make sure that the user story

1

I have sent the user story to the client
2

The client has signed off on the user story

Feature Design Review

Review the design for the task and ensure it is detailed enough to have a good outcome.

Development (1-3 days):

Module Setup

A Pax module is a reusable software component that can be shared between projects with all required documentation. Below are the required components to build out a module. Please see Chris Hemming for training on what a module is.

Insert the link to the readme.md in github. The readme should explain what the project is, how to install the project, and how to find documentation, as well as author information. It should also mention that it is property of Pax.

Reviewer: this has been completed correctly

Insert the link to the example usage notebook, within the roughNotebooks directory. This gets other developers started with key concepts quickly.

Reviewer: this has been completed correctly

insert the link to the example first endpoint python file.

Reviewer: this has been completed correctly (Copy) (Copy)

insert the link to the test.py file, used for running unit tests

Reviewer: this has been completed correctly (Copy) (Copy) (Copy)

Lastly, you need to create master, distribution, and development branches. Link to the so this can be checked

Reviewer: this has been completed correctly (Copy) (Copy) (Copy) (Copy)

1

Module Setup is ready for review

Module Review

Several requirements need to be satisfied to consider a module to be setup correctly. Please ensure that is the case for the module. If you are able to sign of on each task the module is created properly.

Dev Setup

Before you begin coding the task, you must create and review your setup with your manager. This means that we must complete a few objectives.

First, You must create a feature branch for this task. Place the link to this feature branch here.

Second, In that feature branch, you must update the readme.md to reflect the development you will start.

Third, we engage in class based development: link the facade / class file for review:

Dev Review

Did the development environment for this task get setup correctly? Did the developer note their additions in readme.md?

Unit Testing

Unit tests ensure that our system functions correctly. You should write unit tests that interact with your facade so that the application can be properly tested. Please implement a test driver and test stub as described in this diagram:

Place the link to your unit test.py so that it can be read

Place the link to your facade so it can be evaluated

Development

Do your development work. After your task is done, place a link to the finished product (development branch, the branch for this checklist) here.

If the task is in asana, please leave a link to the finished task in asana here.

1

Development is Complete

Review Information

Assign a Reviewer to this step of your task.?

What is the test link (the link the reviewer should click on)?

Paste the final User Story introductions here:

Link to the development branch on github: Your code will be evaluated.

Please add this task to the feature database

1

Task is ready for review
2

Task has been added to Feature Database

Review (1 day):

For Reviewer

1

Reviewer: I have executed the user story (See Review Information)

The system works

If the system has a problem, what is the issue?

For the Reviewer: Run the unit tests. Do all unit tests pass? Do you have feedback?

For Code Review. Did the user follow: 1. Two is too many, 2. Separation of Concerns, 3. Magic Numbers

Reviewer: This task is finished, complete, and should be accepted into the code base.

1

Task is reviewed

Final Merge

After Development, and review, The final task is ready to be merged into distribution. ONLY IF YOUR TASK PASSED QA, you may merge your task with distribution. Please review github merge standards

Please copy the task branch link here

Please copy the distribution branch link here