step by step issue checklist

checklist.md

Yellow warnings are errors, don't ignore them.

You may at any point in the checklist need to backtrack when making code corrections and adjustments.

With all steps write down questions and notes as they arise.

Don't assume the code runs. Test it and be sure it runs.

Gather Intel

• read the issue
• re-read the issue making sure you understand every line, note any questions
• create a list of the features required by this issue (fields, elements, page content)
• if you have any outstanding questions reach out to clarify your concerns adjusting your list as necessary
• compare your list with any provided mockups to double check you've got everything accounted for
• group items on your list by likely component proximity (all of the fields go together, everything in a sidebar)
• split those groups of items into subgroups as required (each section in a sidebar, types of fields)
• save that list in a comment on the issue, start working

Work cycle

• after each item is complete mark the item is draft
• when all drafts are complete or a group of drafts is completed go over each item again
• after reviewing the a set of drafts replace the draft marker with stage
• rinse and repeat until all items for a feature are in draft

Manual testing and code review

• check feature functionality again for each group of items repacing stage with ready
• perform a manual code review by running a git diff to see what you've removed or added
• run eslint on the front-end code
• run any front-end or back-end tests available

Completing the issue

• check in with yourself to ask if you are proud, confident and happy with the result
• create the PR and repeat these steps with any provided feedback
• after the PR has been vetted prepare for functionality feedback
• with each item of feedback repeat these steps

Example

• status task item