The goal of this project is to work together to build a “smart” shopping list that learns your shopping habits over time, putting items you are most likely to need to buy in the near future at the top.
This project is based on iNeedToBuy.xyz, a mobile web app I built for my own use last year. You’re welcome to look at the GitHub repo for that site if you get stuck and want a hint!
- Site: https://tcl-3-smart-shopping-list.netlify.com/
- Repo: https://github.com/the-collab-lab/tcl-3-smart-shopping-list
- Clone URL:
git@github.com:the-collab-lab/tcl-3-smart-shopping-list.git - Issue list: https://github.com/the-collab-lab/tcl-3-smart-shopping-list/projects/1
- Project wiki: https://github.com/the-collab-lab/tcl-3-smart-shopping-list/wiki
- Database: https://console.firebase.google.com/project/tcl-3-smart-shopping-list/database/firestore/data~2F
The project is expected to take 40 hours per participant, spread over 8 weeks.
Each week, the team of 4 developers will split into 2 pairs of 2 developers each. Each pair will take on a story or task from the issues list to work on together that week.
Pairings will go as follows:
- Radhika & Ernie
- Nikema & Mike
- Monica & Nikema
- Mike & Amber
- Monica & Mike
- Amber & Nikema
- Monica & Amber
- Mike & Nikema
- Nikema & Monica
- Amber & Mike
- Mike & Monica
- Nikema & Amber
- Amber & Monica
- Nikema & Mike
- Monica & Nikema
- Mike & Amber
A portion of your dedicated hours each week will be spent pair programming with your partner — this is where the most magical collaboration happens.
Pair programming offers some really exciting opportunities to teach/learn from your partner, get a different perspective and/or insight on the issues you’re facing, and drive forward progress on your goals.
There is no one “right” way to pair program, but in general, you will meet with your partner on Zoom to work through the story or task you’ve chosen for that week. You’re encouraged to test out some different approaches to pair programming to see what works best for your and your partner’s collaboration styles.
At the end of each week, we’ll get on a 45 minute Zoom call. The call will always start with a quick demo from each pair of the previous week’s work. This is a common practice on most software teams and an opportunity to practice talking about your work, which can come in handy in a job interview setting!
On odd-numbered weeks, we’ll use the rest of the time to cover a learning topic. On even-numbered weeks, we’ll do a short retrospective of the previous 2 weeks. In the retros, we’ll share appreciations of our teammates as well as talk about what went well from a process perspective and what we could do to improve how we’re working together.
The project is organized in GitHub as a set of user stories, each with a description of the desired functionality as well as acceptance criteria (AC) that describe how you know whether the task or story is complete. You can find the stories on the project board on GitHub.
A task or story is “done” when the following are all true:
- The AC have been met
- Tests have been written to validate the “happy path”
- In the case of a UI feature, it has been reviewed for accessibility
- The code to complete the task or implement the feature has been reviewed and approved by the other pair of developers
- The Product Owner (i.e. Andrew or one of the other mentors) has accepted the work as satisfactorily meeting the functional requirements
The “backlog” (the collection of stories) represents the work needed to complete the project. At the point when all of the stories are done, we should have a working app!
At the start of each week, each pair will create a page on the project wiki where you can coordinate your approach to solving your problem for the week, surface blockers and learnings, etc. One of the benefits of this is that the people reviewing your work can better understand your process for how you got to your solution.
Work will be done on feature branches in git. Branches should be named in the following way:
<initials of person 1>-<initials of person 2>-<short description>
For example:
lb-sg-connect-to-firestore
The hypothetical example above has Lars Brekken and Steve Gardner working together on connecting the app to Firestore. Each of them will be able to work on the feature branch independently, but only one of them will submit the pull request (PR) when the work is ready (described in more detail below).
When you’re ready to start work on a feature, one person in your pair should create a local branch following the naming convention above, then push the branch to GitHub so their pair buddy can pull it down to their local environment. The following steps should work to do just this:
git checkout -b my-example-branch
git push -u origin my-example-branch
When you and your pair partner have working code that you believe is ready to be merged to master and deployed, you will follow the following steps:
- Create a PR.
- Notify the other pair team in Slack that you have a new PR for them to review.
- Incorporate feedback from the other pair team into your work until both you and they are satisfied the code is ready to be merged.
- Request that Andrew or one of the mentors review the PR for final approval.
- Once approved, merge the PR into
master. Your code will be built and deployed to production automatically thanks to Netlify. (It’s good form to delete the feature branch after you’ve merged a PR.) - Check your work on the production site.
- Celebrate! 🥳
I’m around 💯% sure I’m forgetting or glossing over something important, so please be noisy on Slack as things come up. The mentors and I will do our best to get you unstuck. Also, lean on each other for help as well! Finally, work in the open so everyone can benefit from your questions.
