The goal of the project is to build a mobile web app that shows you nearby Wikipedia entries.
This project is based on whats-near.me, a mobile web app I recently built for my own use. You’re welcome to look at the GitHub repo for that site if you get stuck and want a hint!
- Site: https://tcl-20-whats-near-me.netlify.app
- Repo: https://github.com/the-collab-lab/tcl-20-whats-near-me
- Clone URL:
[email protected]:the-collab-lab/tcl-20-whats-near-me.git - Issue list: https://the-collab-lab.atlassian.net/secure/RapidBoard.jspa?rapidView=1&projectKey=TCL20
- Google Cloud Console: https://console.developers.google.com/apis/dashboard?project=tcl-20-whats-near-me
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:
- Rachel & DeVon
- Shayne & Caitlyn
- Rachel & Caitlyn
- Shayne & DeVon
- Shayne & Rachel
- Caitlyn & DeVon
- Rachel & DeVon
- Shayne & Caitlyn
- Rachel & Caitlyn
- Shayne & DeVon
- Shayne & Rachel
- Caitlyn & DeVon
- Rachel & DeVon
- Shayne & Caitlyn
- Rachel & Caitlyn
- Shayne & DeVon
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.
Each week, we’ll get on a 1-hour Zoom call. The call will always start with a quick demo of the previous week’s work from each pair. This is a common practice on most software teams and also lets you practice talking about your work, which can come in handy in a job interview setting!
The way we use the rest of the time will vary based on whether it’s an even- or odd-numbered week, as follows:
- Demos/discussion (15 minutes)
- Learning module (30 minutes)
- Team reviews in-progress and upcoming issues (15 minutes)
- Demos/discussion (15 minutes)
- Retrospective (30 minutes)
- Team reviews in-progress and upcoming issues (15 minutes)
Our retro format will change each week. Watch the team channel for more details!
A week sounds like a long time in some ways, but part of working on a team is accounting for coordination costs. Let’s walk back our goal of demoing from the production URL on Sundays to see when different things need to happen.
- Sunday — Demo on production!
- Saturday — Respond to mentor feedback on PRs
- Friday — Respond to/give peer feedback on PRs and ping mentors for feedback
- Thursday — Complete story and ask for peer feedback
- Monday, Tuesday, Wednesday — Work out approach, research if needed, pair program
Having watched many cohorts before yours, our advice is to front-load the work as much as possible in the first couple of days of each week. Some of the stories are trickier than they appear on the surface!
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
- The code to complete the task or implement the feature has been reviewed and approved by the other pair of developers
- The code has been reviewed and approved by one of the mentors
- The Product Owner (i.e. one of the mentors) has accepted the work as satisfactorily meeting the 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!
It’s super helpful both to yourself and the mentors for you to document your work. This can prevent you from losing track of details or decisions you make with your pair buddy. It also allows mentors to catch up on your progress when you ask for help.
You are strongly encouraged to create a draft PR as one of their first steps in getting started with the work. An advantage of this approach is you can have a conversation about the work right alongside the code. This, coupled with discussions about approach in the issue itself, is nice way of documenting your progress as you go.
You can also ask for clarification about stories directly on the issues themselves in Jira.
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:
st-an-render-map
The hypothetical example above has Stacie Taylor and Alejandro Ñáñez working together to get a map to render. Each of them will be able to work on the feature branch independently, but only one of them will submit the merge request 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 your pair buddy can pull it down to their local environment. The following steps should work to do just this:
git checkout -b an-example-feature-branch
git push -u origin an-example-feature-branch
When you and your pair partner have working code that you believe is ready to be merged to main and deployed, you will follow the following steps:
- Create a pull request (PR) describing the work done, the before and after states, and how to validate that the changes work as intended
- 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
main(your code will be built and deployed to production automatically thanks to Netlify) - 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 un-stuck. Also, lean on each other for help as well! Finally, work in the open so everyone can benefit from your questions.
