13 Jun 2019

# Meetings

History / Edit / PDF / EPUB / BIB / 2 min read (~294 words)

### Before

• Write/prepare an agenda listing the items to be discussed
• Indicate the duration and responsible/lead of each
• Aim for a meeting to last under an hour. If more time appears to be required, then prior work should be done in order to reduce the amount of time necessary for the meeting.
• Define the list of invitees, try to keep it short, possibly under 6 people
• Share the agenda with all the attendees

### During

• Present the agenda
• Designate a person that will make sure that the agenda is respected

### At the end

• Determine next actions
• Define deadlines for each next action
• Assign a responsible for each next action

### After the meeting

• Create tasks in a task tracking system for the next actions

### Recurrent meetings

• In the case where a recurrent meeting needs to be scheduled at a different time than usual, specify in the body of the message the reason of the change.
25 May 2019

# Writing bug tickets

History / Edit / PDF / EPUB / BIB / 1 min read (~117 words)

## Ticket content

• Summary
• Software version
• Environment details: compiler/interpreter, operating system, etc.
• Steps to reproduce
• Expected results
• Actual results
• Screen capture (if relevant)

## References

25 May 2019

History / Edit / PDF / EPUB / BIB / 4 min read (~783 words)

## Steps to create a task

• Give it a title
• Give it at least one label
• Give it an assignee
• Decide if it's important or not
• Decide if it's urgent or not
• Estimate the effort required to accomplish the task (in hours)
• Estimate the value the task brings (in $) • Give a rough estimate of effort • Give a description if necessary • Set a deadline if possible • Set status to Unprioritized ## During a workday • Go through the tasks in the Do section, then the Decide section, then Delegate ## Important/Urgent Use Eisenhower matrix to determine task importance/urgency • Tasks that are not important/not urgent are moved to the backlog • Tasks that are not important/urgent are delegated to someone else • Tasks that are important/not urgent should be scheduled • Tasks that are important/urgent should be done ASAP ## Effort/Value/ROI Using the estimated effort and estimated value of a task, you can compute the return on investment (ROI) of the task as estimated value divided by estimated effort. For example, a task you estimate is worth 100$ and takes 2 hours to complete will have a ROI of 50 \$/h. Use the ROI of your tasks to prioritize them. You will want to complete the tasks which are likely to have the best return on investment. The ROI metric will also give you clues about the task you should probably not spend your time on. If you are paid 50$/h and a task has a ROI less than 50 \\$/h, then it should probably be moved to the backlog and only reconsidered if its ROI changes.

• You should attempt to keep the Unprioritized tasks count to 0
• Work on tasks In progress first, then take tasks from Today, then from Queued

24 May 2019

# Reviewing code

History / Edit / PDF / EPUB / BIB / 2 min read (~337 words)
• Verify that the build/tests pass
• Understand the feature and associated requirements that are supposed to be implemented
• Check code implements the desired feature and that the requirements are completed
• Check code contains tests
• Is all the new code covered by those tests?
• Verify the location of new files
• Are the files in the right directory?
• Are they appropriately named?
• Verify classes, methods, functions, parameters naming
• Are they significant of their purpose?
• Are they clear enough?
• Are they respecting the naming convention?
• Does the code respect SOLID?
• Consider that when functions/methods signature change, code may now be backward incompatible.
• Discuss whether this is necessary
• Backward incompatible changes should be documented
• Are there TODOs that should be completed within this review?
• Check code for code style issues

24 May 2019

# Software project basics

History / Edit / PDF / EPUB / BIB / 1 min read (~143 words)
• Code changes are stored in git
• Setup continuous integration
• Have a testing framework
• Use dependency management
• Define a code standard
• Prefer function/method typing over dynamic types
• On every push to git
• Code quality check
• Code style check
• Unit/functional/integration/system tests
• Code coverage should be recorded during tests and a report made available
• A project repository must have a README.md explaining how to run the project on your own computer
• A project repository must have a RELEASING.md explaining how to release the code
• Responsibilities are made explicit in terms of roles
• Critical roles, such as project lead, must have a backup/shadow individual