feat: migrate mentorship wiki

2025-10-29 19:53:22 -07:00
parent 4298548347
commit 2d3d684894
13 changed files with 495 additions and 7 deletions
@@ -20,19 +20,15 @@ Upon successful enrolment, the Mentee receives the following benefits:

 Participants will have access to private Discord channels exclusively for Mentees. These channels get priority response times from the NHCarrigan team. All participants must adhere to our [Code of Conduct](/community/coc).

-### 2.3 Group Meetings
-
-If the Programme enrols five (5) or more participants within a given month, all Mentees will be invited to a weekly monthly group meeting. This meeting will provide opportunities for group discussions, shared experiences, and networking.
-
-### 2.4 Flagship Project
+### 2.3 Flagship Project

 Participants will gain maintainer-level access to a repository under our [Mentorship GitHub organisation](https://github.com/nhcarrigan-mentorship), which they will use to build their flagship project under the tutelage of our team.

-### 2.5 Career Prep and Resume Building
+### 2.4 Career Prep and Resume Building

 Participants will have the opportunity to build their resumes through an internship with NHCarrigan. This includes eligibility for project contributions and collaboration with the NHCarrigan team.

-### 2.6 Ongoing Support and Resources
+### 2.5 Ongoing Support and Resources

 Mentees will receive continuous resume reviews, personalized learning roadmaps, and dedicated guidance for the duration of their membership. Additional resources and Programme updates will be provided as part of this lifetime membership support.

@@ -0,0 +1,47 @@
+---
+title: 00. Frequently Asked Questions
+---
+
+This page outlines some of the frequently asked questions we see.
+
+## Does the mentorship programme cost anything?
+
+Nope! We offer this programme entirely for free. You *may* have to pay for things like hosting to deploy your app, but you will do that directly - we do not collect any tuition or academic fees.
+
+That being said, if you would like to [donate so we can continue offering this free programme](https://donate.nhcarrigan.com/) we would greatly appreciate it!
+
+## Why does Naomi take so long to respond?
+
+We do our best to respond as quickly as possible. Please understand that Naomi does this completely for free, and works multiple paid jobs to cover her expenses.
+
+As such, this means she is very busy and can be slow to respond. If we have not responded to you within 3 days, please feel free to ping us with a gentle reminder. Repeatedly pinging us with a greater frequency than every three days may result in sanctions.
+
+Thank you for your patience and understanding.
+
+## What if I change my mind?
+
+You are welcome to leave the mentorship programme at any time! We are not going to hold you hostage, or charge you fines. We only ask that you let us know you wish to drop out and why, so we can track feedback and graduation rates.
+
+We promise not to pressure you to stay, regardless of the reason you choose to drop out.
+
+## I do not want to drop out, but I have a life situation going on...
+
+Totally acceptable! We do not have activity requirements. If you need to take a break to address other circumstances, just let us know (so we don't ping you with reminders)!
+
+## Will you kick us out at all?
+
+Yes, but expulsion is done only under specific circumstances:
+
+1. You completely ghost us - you have not communicated the need for a break, and are not responding to our messages. If you disappear for two weeks or more without informing us, we will have to remove you to make room for someone who is ready to commit.
+2. You violate our [Code of Conduct](https://docs.nhcarrigan.com/community/coc/). Sorry, but our rules foster a safe and inclusive learning environment, and if you choose not to obey them we cannot have you in our community spaces.
+3. You engage in malicious behaviour. If you intentionally push malware or viruses to your repository, or you design a project that actively harms people, we will not support that and you will be expelled.
+
+## What if I have a question not covered here?
+
+Ping us in #mentee-chat! We are always happy to answer questions!
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,31 @@
+---
+title: 01. Onboarding
+---
+
+Once your application has been reviewed and accepted, you will receive an email confirmation. You MUST reply to this confirmation with your GitHub username.
+
+:::caution
+If you do not respond to the confirmation email with your GitHub username, we will not be able to complete your onboarding.
+:::
+
+## Discord
+
+You will need to join our [Discord community](https://chat.nhcarrigan.com/). This is where the bulk of our planning, coaching, and conversation will happen.
+
+When you join, ping Naomi in the general chat channel and request the mentorship role. She will grant you this role, which allows you to access the necessary channels.
+
+## GitHub
+
+:::caution
+The repository we provide you is ONLY for your flagship project. You should NOT commit any other code, such as practise projects or leetcode solutions. This is the repository you will be listing on your resume for job applications, so you want it to be you at your best!
+:::
+
+You will receive an invite to a dedicated repository under this organisation to hold the code for your flagship project. You will need to accept this invite within 7 days, or it will expire.
+
+You will have maintainer access to your repository, so you can configure various settings like workflows and branch protections. You will not have access to destructive settings.
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,36 @@
+---
+title: 02. Goal Setting
+---
+After your onboarding is complete, you will need to begin your goal-setting. Create a thread in the #goal-setting forum on our Discord, and name it as follows:
+
+```markdown
+<full name> - Goals
+```
+
+In your initial post, you will want to outline the following information:
+
+- The type of role you want for your career (e.g. full-stack dev, front-end dev, mobile dev, game dev)
+- Your current learning state (what languages you know, what projects you have built)
+- Your interests outside of coding (hobbies, passions, etc)
+
+Our team will use this information as the starting point for your road map. We may ask some follow up questions.
+
+## Road Map
+
+To finalise your goal setting conversation, we will provide a 12-week road map to outline your learning and completion of your flagship project. We will ask for your confirmation of the road map.
+
+Be sure to take the time to read it thoroughly, and assess whether it seems achievable, aligns with your goals for the programme, and incorporates your interests.
+
+:::note
+Plans must be solid, but reactions flexible.
+:::
+
+The 12-week road map is not set in stone - we will adapt to changes in your situation, timeline requirements, etc. It merely gives us the scaffolding we need to best guide your journey.
+
+Once you sign off on the road map, we will be ready to move to the project planning stage.
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,30 @@
+---
+title: 03. Project Planning
+---
+
+Once your goals are set, we will begin iterating on your flagship project. Create a post in the #project-plan forum channel, using the same naming convention:
+
+```markdown
+<full name> - Project Plan
+```
+
+In your post, you want to provide as much detail as you have about your project idea. If you do not have an idea yet, that is okay! Create your post with something like "I need help brainstorming a project idea". We will gladly work with you to find a project that furthers your goals and aligns with your interests.
+
+Once your post is created, our team will work with you to flesh out and polish the idea into something refined and ready for work. You should end up with a project plan like:
+
+```markdown
+A life task tracker app thats open source and self-hosted as well as a live version hosted on my website with user auth and such. Could have kanban boards and different views and such, and have tasks that depend on other tasks just like on a github projects board.
+
+Could also link rewards to tasks / projects. e.g. Car Maintenance project with sub tasks of cleaning car, changing oil, buying car charger for cig lighter port etc, and then could link to an item that you will buy for yourself as a reward for when the entire project is complete, and itll have a link to that item when you mark the project as complete
+
+At the end I could sneak some gamification elements in as an opt-in thing where you can level up and such by completing tasks / projects/ completing life goals).
+
+```
+
+Our team will give the final sign-off on your project plan, and you will be ready to start writing user stories!
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,27 @@
+---
+title: 04. User Stories
+---
+
+Creating user stories is a crucial step in planning your project. This helps you visualise and understand your application's requirements, broken down into digestible isolated chunks so you can maintain a smaller scope of work for each task.
+
+Based on your project plan, you will want to create an *individual issue* on your GitHub repository for *each user story*. So, if you have 30 stories, you should have 30 issues.
+
+## What is a user story?
+
+A user story is an application requirement that is written from the perspective of an end user. Here are some examples:
+
+- As an unauthenticated user, I can see a button to go through the login or registration flows.
+- As an authenticated user, I can fill out a form to schedule an appointment and select from available dates and times listed on a calendar.
+- As an administrator, I can review posts for their content and remove the ones that violate our policies.
+
+## Why separate issues? Can I not use a single issue with a list?
+
+Maintaining separate issues, or tickets, allows you to link each user story to a specific pull request. This is a common workflow, and ensures that your changes remain within the scope of a specific story.
+
+Once you have your user stories all logged as individual issues, ping Naomi in the #mentee-chat for a final review. If we sign off on your issues, we will move into the technical breakdown step.
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,98 @@
+---
+title: 05. Technical Breakdown
+---
+
+Once your user stories are complete, Naomi will audit them. She may have some feedback, but generally she will sign off on them by editing the issue to include this template:
+
+```markdown
+## 🎯 Acceptance Criteria
+- [ ] Criteria 1 (clear, testable condition)
+- [ ] Criteria 2
+- [ ] Criteria 3
+
+---
+
+## ⚙️ Technical Details
+- Proposed implementation approach:
+  - [ ] e.g., API endpoint, UI component, database schema changes
+- Data considerations:
+  - [ ] Models, validation, storage needs
+- Security/permissions:
+  - [ ] Any auth or role checks?
+
+---
+
+## 🔗 Dependencies
+- [ ] Related tickets or features
+- [ ] External services or APIs
+- [ ] Libraries or frameworks required
+
+---
+
+## 🧪 Testing Notes
+- [ ] Unit tests to cover…
+- [ ] Integration tests to cover…
+- [ ] Manual QA steps…
+
+---
+
+## 📂 Additional Context
+- Links to designs, diagrams, or docs
+- Any constraints or assumptions
+- Open questions / things to clarify
+
+```
+
+This template is specifically designed to help you understand how to break down your user story into actionable components. Which means your next task is to fill it out!
+
+Take your time and be as detailed as possible. Remember, the more planning you do now, the less factoring you need later.
+
+## Example
+
+Say I have a user story "As a user, I should be able to add a game to my library". I would **edit the issue body to fill in the template** like so:
+
+```markdown
+🎯 Acceptance Criteria
+- [ ] User can add game to library
+- [ ] User can remove game from library
+
+---
+
+⚙️ Technical Details
+- Proposed implementation approach:
+  - [ ] POST /library
+- [ ] DELETE /library
+- Data considerations:
+  - [ ] User model must have library property
+  - [ ] Library property must be array with game IDs
+  - [ ] Each ID points to a Game model record
+- Security/permissions:
+  - [ ] Validate JWT to ensure authenticated user is correct
+  - [ ] Authenticated user can only add games to their own library
+
+---
+
+🔗 Dependencies
+- [ ] #2 - Authentication is required to edit my library
+- [ ] #5 - Profile UI necessary to get to this view
+
+---
+
+🧪 Testing Notes
+- [ ] POST and DELETE routes should be tested with mock data
+- [ ] UI should be tested to ensure functionality
+
+---
+
+📂 Additional Context
+
+- Relational data model means using Mongo might not be the best choice. Should we re-evaluate?
+- Consider a GET route for displaying the library.
+
+```
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,45 @@
+---
+title: 06. Priority and Effort
+---
+
+Your next step is to apply labels to your user stories that indicate the priority and effort level. These labels have NOT been created for you, so you will need to create the labels for your repository - we are not enforcing a specific naming convention, so use the labels that best align with your organisational style.
+
+There are two things you want to have labelled on each issue: priority and effort.
+
+## Priority
+
+Assigning priority to your user stories is probably not what you might expect. You are not using something like "this is more fun to work on, so higher priority", or "this does not excite me so I will de-prioritise it".
+
+Instead, you will look solely at what is blocking/blocked by each issue. For example, consider these three user stories:
+
+1. As an unauthenticated user, I should be able to create an account or sign in to my existing account
+2. As an authenticated user, I should be able to customise my profile
+3. As an authenticated user, I should be able to create a new post
+4. As a user, I should be able to view someone's profile.
+
+If we look at what is blocking what, user story 1 blocks stories 2 and 3! You cannot be an authenticated user if we do not provide a way to register and sign in.
+
+So issue 1 would be a high priority, because it blocks work on 2 and 3. But 2 and 3 do not block each other, so we could consider them both a medium priority. Issue 4 is blocked by issue 2, because it makes no sense to allow the viewing of profiles if there are no profiles to customise! Following our logic, then, issue 4 would be a low priority.
+
+Again, how you choose to "name" and assign priorities is up to you - the general idea is that you should be able to look at your priority labels and quickly determine what needs to be done next (because it is the highest priority).
+
+## Effort
+
+The next set of labels you need to apply involve determining the amount of effort required to complete the user story. Now, every organisation handles this differently. You may have heard of "story points" before, which are a way of indicating effort levels.
+
+How you choose to label and quantify effort is up to you. For this example, we will use a points system. Given our existing user stories above, we might assign the following points:
+
+1. Five points (building out an entire authentication flow is very complex).
+2. Three points
+3. Three points
+4. One point (showing a static page is less complex).
+
+The purpose of applying these labels is to help you plan out the timeline of work. For example, if you have three high-priority tasks, but only have a few hours free on a Friday afternoon, you might consider completing the lowest-effort task because you have restricted time.
+
+Once your priority and effort labels are applied, ping Naomi in the #mentee-chat again to discuss your decisions and categorisation. After we approve your labels, you are finally ready to start working on actual code!
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,37 @@
+---
+title: 07. Writing Code
+---
+
+You are finally ready to start writing some code... But wait! We still have a couple of things to consider.
+
+## Branching Strategy
+
+As is common when you are working on a team professionally, you are **not** able to push directly to your `main` branch. Instead, you are required to create a dedicated branch for your work and make a pull request to bring your changes back into `main`.
+
+Each branch should be scoped to a *single* user story. This ensures that your pull requests remain in a manageable state and are not too massive to review.
+
+## Pull Request Reviews
+
+Every pull request will require a review from Naomi. This ensures that we have eyes on all of the work you do, and can be in lockstep with you as you ship new features. We will review your code as if you were in a professional setting - so we will look at best practises, code quality, feature completeness, etc.
+
+Much like in a professional role, each pull request review will likely involve a bit of back-and-forth communication. Remember that this is a marathon, not a sprint, and every review comment we make is designed to help you learn and improve your skills.
+
+## Next Steps
+
+You will want to start by scaffolding your project - add any tooling structure (e.g. a `package.json` file for Node.js projects) and configuration (e.g. `black` for a Python project).
+
+Then configure a CI file to run on every pull request to ensure things like your `lint`, `build`, and `test` steps all pass.
+
+Setting all of this up NOW ensures that any code you write meets your quality requirements right out of the gate, and saves you from having to fix issues across dozens of files if you were to set up your tooling later.
+
+## Yay! It is Coding Time!
+
+You did it. You can start writing some actual code! Remember to work on a dedicated branch for each user story.
+
+Commit early, commit often, push every time. The last thing you want to do is lose your hard work!
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,37 @@
+---
+title: 08. Final Polish
+---
+
+When you feel like your flagship project has reached a state where you can proudly show it off on your resume, ping Naomi yet again in the #mentee-chat.
+
+## Code Cleanup
+
+At this point, we will go through your project with a fine-toothed comb, adding new issues as we identify things that need to be resolved.
+
+You'll need to circle back and address those issues - and we will rinse and repeat this cycle until your project is polished up and ready to go.
+
+## Documentation
+
+Then, we'll coach you on how to write documentation for your product. You will need to establish the standard documentation files:
+
+- A [README.md](http://readme.md/), which provides a high-level overview of your project
+- [CONTRIBUTING.md](http://contributing.md/), which has the instructions for someone looking to come help work on your project
+- [LICENSE.md](http://license.md/), which determines what people can and cannot do with your software
+
+We will also determine an approach for in-depth end user documentation.
+
+## Hosting!
+
+Finally, you need a live version of your application! Our team will help you figure out the best way to deploy your app, and which hosting providers will fit your needs.
+
+:::caution
+You definitely want to consult with us BEFORE deploying your application, as we can provide guidance such as free hosting options, deployment pipelines, etc.
+:::
+
+We will also help you set up a domain to point to your live project, if you are interested - note that domains generally cost money. So does hosting. We'll do our best to find free options for you, but that's not always viable.
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,31 @@
+---
+title: 09. Career Prep
+---
+
+Hurray! You made it! It is now time to start your job hunt in earnest! There are a few things we will do to help you get ready for this process.
+
+## Resume Review
+
+We will work with you to get a polished resume/CV ready to hand out to potential employers. And your resume will definitely include your flagship project!
+
+## LinkedIn Prep
+
+We will help you curate your LinkedIn profile to help you stand out and position you for success.
+
+## Application Assistance
+
+We will gladly help you refine your job search and application process. We cannot, and will not, complete job applications for you - but will totally help you figure out what to say.
+
+## Mock Interviews
+
+Once you start landing interviews, we will do some mock interviews to best prepare you to succeed in the real thing!
+
+## JOB!!!!!
+
+We will continue to do all of this, and refine and iterate on your flagship project, until we have reached the magical combo that gets you employed! 🎉
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::
@@ -0,0 +1,23 @@
+---
+title: 10. Graduation
+---
+
+Our mentorship programme is very flexible. There are no set deadlines, no requirements you must complete to "finish the programme", etc.
+
+Instead, we focus on one thing and one thing only: reaching your career goals. As such, once you land your dev job, you have completed the mentorship programme!
+
+:::tip
+It is entirely possible that you land a job before you even complete your flagship project. That repository is yours to keep forever, so you will be able to continue working on it as you like. But when you land your job, regardless of where you are at in your roadmap, you will have successfully graduated from our programme!
+:::
+
+While we will gladly provide continued coaching, advice, and recommendations, we *will* remove you from the official programme once you are hired. This allows us to open up space for the next generation of developers looking to find their success just like you did!
+
+We do maintain an alumni programme. You will still have access to post in the mentorship channels, but not to get help with your own plan - instead, you'll be helping coach and guide others! Succeeding as a developer requires leadership skills, and our hope with the alumni programme is to give you the space to develop those skills.
+
+You will also go on our public list of alumni!
+
+:::tip[Helpful Links]
+- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
+- [Discord](https://chat.nhcarrigan.com/)
+- [Donate](https://donate.nhcarrigan.com/)
+:::