Skip to content

Commit 41ec4fa

Browse files
authored
update vi and mi intern orientation doc (fixes #3454) (#3455)
1 parent f20b991 commit 41ec4fa

File tree

5 files changed

+141
-106
lines changed

5 files changed

+141
-106
lines changed

pages/mi/mi-10-steps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,6 @@ Additionally, you may also go over the official [Kotlin tour](https://kotlinlang
114114

115115
## Step 10 - Be part of the team
116116

117-
Next thing is to add yourself to the virtual intern list found in [mi-team.md](mi-team.md) and create a pull request. Message us ("@okurole_25668", "@dogi" and "@vi-mobile") in the Discord channel so that we can set up a meeting and add you to the team as soon as possible.
117+
Once you've confirmed that you've met the requirements in the [progress tracker](../track-first-steps-progress.md), your next step is to add yourself to the virtual intern list in [mi-team.md](mi-team.md) and submit a pull request. Afterward, message us ("@okurole_25668", "@dogi", and "@vi-mobile") in the Discord *#lagrangelounge* channel to schedule a meeting and officially join the team.
118118

119-
Make sure to read through the [intern orientation document](mi-intern-orientation.md) before the meeting.
119+
After scheduling the meeting, and before it takes place, be sure to review the [Mobile Intern Orientation document](mi-intern-orientation.md) before the meeting.

pages/mi/mi-intern-orientation.md

Lines changed: 67 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,110 +2,129 @@
22

33
## Welcome to the OLE Mobile Intern Team!
44

5-
Congratulations! You have completed the first steps and have been selected to join the Open Learning Exchange mobile virtual intern team. Please remember that we expect interns to have at least 24 hours a week for the minimal of 3 months to work on Open Learning Exchange issues. If you do not currently have enough time, we will be happy to have you later when you do have time.
5+
Congratulations! You have successfully completed the First Steps and have been selected to join the Open Learning Exchange mobile intern team.
66

7-
## Get to Know the Team
7+
The first step is to get to know the team, including our CTO [dogi](https://github.com/dogi) and the [current intern team leads and members](#!./pages/mi/mi-team.md). You'll have the opportunity to meet us face-to-face in our "virtual office" via Google Meet during the initial meeting.
88

9-
The first thing is to meet the team, starting with CTO [dogi](https://github.com/dogi), then the [current intern team leads and members](#!./pages/mi/mi-team.md). After having the initial meeting with dogi, you can join <http://talk.ole.org> during Google Meet session to meet with current interns, get to know each other, and ask them what they have been working on.
9+
Please note that we expect interns to commit at least 24 hours per week for a minimum of 3 months to work on Open Learning Exchange projects. If you currently don’t have enough time, we’d be happy to welcome you later when your schedule allows. You can find more information in our [FAQ](mi-faq.md).
1010

1111
## Familiarize Yourself with Current Projects and Issues
1212

13-
Typically, interns choose what project they want to work on based on their experience. If you get tired of a certain project, there is an opportunity to switch. Take a look at our current projects below, if any particular ones interest you, there is a very good chance that you can work on them.
13+
Typically, you are invited to the OLE internship that best aligns with your experience. Interns also have the opportunity to choose projects based on their interests and skills. If you feel stuck on a particular project, there is the option to switch. Take a look at our current projects belowif any catch your interest, there’s a very good chance you can work on them.
1414

15-
**Current Active Mobile Projects**
15+
To stay updated on the projects you’re contributing to, be sure to "Star" and "Watch" the repository on GitHub.
1616

17-
- [myPlanet](https://github.com/open-learning-exchange/myplanet)
18-
- An Android app that syncs with Planet to save data for offline use and send usage data.
19-
- [Remote](https://github.com/treehouses/remote/)
20-
- An Android app that communicates with headless Raspberry Pi mobile server running treehouses image via Bluetooth.
17+
#### Mobile Intern Projects
2118

22-
## A Few Things to Know...
19+
- [myPlanet](https://github.com/open-learning-exchange/myplanet): An Android app that syncs with Planet to save data for offline use and send usage data. This is the default project we will assign you to.
20+
- [Remote](https://github.com/treehouses/remote/): An Android app that communicates with headless Raspberry Pi mobile server running treehouses image via Bluetooth. You may also work on this project if you have a Raspberry Pi 4 or 5.
2321

24-
### Becoming a GitHub Organization Member
22+
#### Projects in Other OLE Internship Tracks
2523

26-
Once you've been officially onboarded as a virtual intern, you'll receive email invitations to join the GitHub organizations: [open-learning-exchange](https://github.com/open-learning-exchange), [ole-vi](https://github.com/ole-vi), and [treehouses](https://github.com/treehouses).
24+
- [Planet](https://github.com/open-learning-exchange/planet): A learning management system designed as a Progressive Web App using Angular and CouchDB.
25+
- [Systems Engineering Related Projects](https://treehouses.io/#!./pages/vi/orientation.md#Familiarize_Yourself_with_Current_Projects_and_Issues)
2726

28-
Upon receiving these invitations, please accept them promptly. Once accepted, mark yourself as a public member in the [list of OLE contributors](https://github.com/orgs/open-learning-exchange/people).
27+
## OLE's GitHub Organization & Feature Branch Workflow
2928

30-
### Transition to OLE's Repositories and Adopt the Feature Branch Workflow
29+
During your onboarding as a virtual intern in the initial Google Meet meeting, you'll receive email invitations to join the following GitHub organizations:
3130

32-
Moving forward, you'll be working directly on OLE's repositories instead of your own forked repositories. We'll be following the [Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow), which allows for better collaboration and code management.
31+
- [open-learning-exchange](https://github.com/open-learning-exchange): This is the main organization that hosts OLE's web and mobile app repositories.
32+
- [treehouses](https://github.com/treehouses): This is the systems engineering branch of OLE's software.
33+
- [ole-vi](https://github.com/ole-vi): Stands for OLE Virtual Intern, a space where you can freely start any OLE-related project and experiment with new ideas.
3334

34-
It's important to note that with this workflow, you have the potential to make more significant changes, so always double-check the branch you're working on. Additionally, commit frequently and create pull requests early in the development process. This enables other virtual interns to review your code and provide feedback, ensuring you stay on the right track from the outset.
35+
Upon receiving these invitations, please accept them promptly. Once accepted, consider marking yourself as a public member in the organization’s member list for both [open-learning-exchange](https://github.com/orgs/open-learning-exchange/people) and [treehouses](https://github.com/orgs/treehouses/people) so others can see that you are a member of the OLE organization on GitHub.
3536

36-
### Reviewing Pull Requests and Issues
37+
Moving forward, you'll be working directly on OLE's repositories instead of your own forked repositories. We'll be following the simpler [**Feature Branch Workflow**](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow), which allows for better collaboration and code management.
3738

38-
One of your responsibilities as an intern is to review and help prospective interns with their issues / pull requests at [open-learning-exchange/open-learning-exchange.github.io](https://github.com/open-learning-exchange/open-learning-exchange.github.io). To begin a review, navigate to the 'Files changed' tab on a pull request. Familiarize yourself with GitHub's review features by referring to the [Review on GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) documentation.
39+
## Issues and Project Plannings
3940

40-
Ensure you're mindful of our diverse community when communicating feedback. Refer to [**A guide for reviewing code and having your code reviewed**](https://github.com/thoughtbot/guides/tree/main/code-review#code-review) for tips on using inclusive language and fostering a supportive environment."
41+
We use GitHub Issues for project planning and issue tracking. We will [assign issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users) for you to work on, but feel free to let us know if there are any specific issues you’d like to tackle. You are also free to create new issues after searching for duplicates. Additionally, you can [filter issues by assignee(s)](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#filtering-issues-and-pull-requests-by-assignees) to keep track of your own tasks.
4142

42-
You should check if the following conditions are met:
43+
To ensure we are always branching from the latest master/main branch and that the branch is prefixed with the issue number, we currently create branches directly from the GitHub issues interface. Please refer to [**Creating a branch to work on an issue** - GitHub Docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue) for detailed instructions.
4344

44-
- [x] issue number is included in pull request title and description in the format of `(fixes #IssueNumber)`, when applicable
45-
- [x] there are no unnecessary files/lines change in "Files changed" tab
46-
- [x] there's a branch for the patch
47-
- [x] the pull request actually fixes the issue
48-
- [x] changes are rendered correctly on rawgit preview
49-
- [x] no merge conflicts
50-
- [x] commits are associated with GitHub account
45+
## Pull Requests
5146

52-
Every time you comment on an issue or review a pull request, message those involved on the [Discord Server](https://discord.gg/mtgGD4EnYW) with a link to the issue / pull request. Also, if you find any issue that must be addressed with a pull request, do not forget to use the `Request changes` option when creating your review.
47+
Commit frequently and create pull requests early in the development process, utilizing [**GitHub's draft pull request feature**](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests). This enables your mentor and fellow interns to review your code and provide feedback, helping to ensure you're on the right track from the start.
5348

54-
### Merging a Pull Request
49+
## Code Review and Collaboration: Reviewing Pull Requests
5550

56-
To merge a pull request, follow these steps:
51+
Familiarize yourself with GitHub's review features by referring to the [Review on GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) documentation. If you find an issue that must be addressed with a pull request, do not forget to use the "Request changes" option when submitting your review.
5752

58-
1. **Approval Requirement:** Ensure that at least two other team members have approved the pull request, and there are no outstanding change requests from others. However, there's an exception for virtual interns adding themselves to `mi-team.md`: they should merge their pull request during their initial meeting interview.
53+
Additionally, please read [**A Guide for Reviewing Code and Having Your Code Reviewed**](https://github.com/thoughtbot/guides/tree/main/code-review#code-review) for a comprehensive overview of best practices for conducting effective code reviews, focusing on clear communication, constructive feedback, and collaboration to enhance code quality and foster team growth.
54+
55+
## Help Other Prospective Virtual Interns
56+
57+
For the first 2-4 weeks, one of your responsibilities as an software intern is to review and help prospective software interns with their issues / pull requests at [open-learning-exchange/open-learning-exchange.github.io](https://github.com/open-learning-exchange/open-learning-exchange.github.io). Please provide feedback to [issues raised by prospective mobile interns](https://github.com/open-learning-exchange/open-learning-exchange.github.io/issues?q=is%3Aopen+is%3Aissue+label%3Ami), be sure to look out for the issues with `mi` label only, as other labels like `vi` is for other internships and you may not have the full picture.
58+
59+
To begin a review, ensure the checklist items in the pull request template are addressed properly by the prospective software engineering interns and make sure the pull request actually fixes the issue.
60+
61+
## Merge a Pull Request
62+
63+
Currently, virtual interns typically do not merge pull requests. To merge a pull request, follow these steps:
64+
65+
1. **Approval Requirement:** Ensure that at least two other team members have approved the pull request, and there are no outstanding change requests from others.
5966

6067
2. **Merging Process:**
6168
- Select "Squash and Merge"
62-
- **Commit Title:** Remove all commit messages in the extended description. Keep the commit title concise, clear, and in lowercase.
63-
- **Closing Issue:** If applicable, include "(fixes #IssueNumber)" in the title to [automatically close the associated issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). If forgotten, manually close the issue and link it to the original pull request. An example of a good commit title: "update vi-configuration.md (fixes #1530) (#1557)", where "1530" is the issue number, and "1557" is the pull request number.
69+
- **Commit Title:** Remove all commit messages in the extended description, with the exception of co-authors. Keep the commit title concise, clear, and in lowercase.
70+
- **Closing Issue:** If applicable, include " (fixes #IssueNumber)" in the title to [automatically close the associated issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). If forgotten, manually close the issue and link it to the original pull request. An example of a good commit title: "update vi-configuration.md (fixes #1530) (#1557)", where "1530" is the issue number, and "1557" is the pull request number.
6471

65-
3. **Notification:** After merging a pull request, mention the author on the [Discord server](https://discord.gg/mtgGD4EnYW). Ensure to include a link to the pull request and the commit ID for reference.
72+
## Notify Others of Updates
6673

67-
### Check-in/Check-out
74+
Whenever you comment on an issue or review a pull request on GitHub that requires action from the submitter, notify those involved by sharing a link to the comment in the relevant Discord channel.
6875

69-
We typically conduct verbal check-ins (similar to "[stand-up meetings](https://en.wikipedia.org/wiki/Stand-up_meeting)") and check-outs. If verbal communication isn't possible, you can use the following text format in our Discord *vi-lounge* channel:
76+
## Check-in/Check-out
77+
78+
We typically conduct verbal check-ins (similar to "[stand-up meetings](https://en.wikipedia.org/wiki/Stand-up_meeting)") and check-outs. If verbal communication isn't possible and you need to leave quickly, you can use the following text format in our Discord server's *#vi-lounge* channel:
7079

7180
```
7281
# Check-in
82+
7383
What did I work on last time?
74-
-
84+
- List what you worked on last time
7585
7686
What is my aim for today?
7787
- List what you are working on - consider linking to the issues
7888
7989
What obstacles are in the way of our progress?
8090
- List any problems
91+
92+
What time I'm planning to leave the virtual office today?
93+
- e.g. 4pm EDT
8194
```
8295

8396
```
8497
# Check-out
98+
8599
What I worked on today
86100
- Consider linking to the pull request when applicable
87101
88-
which date and time are we going to meet you next
102+
Which date and time are we going to meet you next
89103
- e.g. Wednesday 10am EDT
90104
```
91105

92106
## Form a Working Routine and Schedule
93107

94108
### Recommended Daily Routine
95109

96-
While you are free to work in your own style, we recommend you follow this basic daily routine:
110+
While you are free to work in your own style, we recommend following this basic daily routine:
111+
112+
- Join the OLE Google Meet session at [https://talk.ole.org](https://talk.ole.org)
113+
- Check Discord channels and your direct messages (DM).
114+
- Check in with us verbally after you go online.
115+
- For the first 2-4 weeks, review any issues tagged with `mi` and the associated pull requests that have been added or changed on [open-learning-exchange.github.io](https://github.com/open-learning-exchange/open-learning-exchange.github.io) since your last review.
116+
- Review other contributor's pull requests in your assigned project(s).
117+
- Work on your assigned issues and don’t hesitate to ask for help in Google Meet or post in the respective repository Discord channel whenever you are stuck on a problems for more than 2 or 3 hours.
118+
- Commit frequently and create pull requests as early as possible to receive feedback as you work.
119+
- Check out with us before you leave the "virtual office." If we are unavailable when you're leaving, please leave a message using the template mentioned earlier.
120+
121+
### Schedule
97122

98-
- Check Discord channels and your discord private messages.
99-
- Join the [OLE Google Meet session](http://talk.ole.org) if you are able to, so you can follow what everyone is working on and get help fast.
100-
- Check in verbally or write a message in Discord vi-lounge channel with the format mentioned above.
101-
- Review any issues or pull requests that have been added or changed on [open-learning-exchange.github.io](https://github.com/open-learning-exchange/open-learning-exchange.github.io) since last time you reviewed.
102-
- Close issues with `(fixes #IssueNumber)` in the pull request squash merge commit message.
103-
- Work on your issues and write in the respective repository Discord channel any time you run into problems.
104-
- Commit often and make pull requests as early as possible, so you can get feedback as you work.
123+
Join the OLE Google Meet session at [https://talk.ole.org](https://talk.ole.org) whenever you can during your work hours to stay updated on what everyone is working on and to get help quickly. This virtual office is typically staffed from 5 AM to 5 PM US Eastern Time during weekdays. As we expand our virtual internship program, we may split into multiple Google Meet sessions or use Discord for synchronous communication.
105124

106-
### Weekly Schedule
125+
While some work can be done offline and outside of the Google Meet "virtual office," especially during unstaffed hours, we generally expect you to be present there for most of your work time, unless you find the virtual office too distracting.
107126

108-
Our Google Meet session can be joined at [http://talk.ole.org](http://talk.ole.org). As we start up our virtual internship program, we might split up into many google meet sessions or use Discord for synchronous communication.
127+
If you are unable to come to the "virtual office" at the time you mentioned during your last check-out, please try to let us know as soon as possible in the *#vi-lounge* channel and @dogi.
109128

110129
## Communicate, Communicate, Communicate!
111130

pages/track-first-steps-progress.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
## Directions
44

5-
* Click on the blue "Get PRs/Issues Count" button below.
6-
* Type in a valid GitHub username
7-
* Remember, in order to complete the First Steps, you need at least 5 valid PRs and 4 issues.
5+
- Click on the blue "Get PRs/Issues Count" button below.
6+
- Type in a valid GitHub username
7+
- Remember, to complete the First Steps, you need a minimum of:
8+
- 4 issues created (one from Step 6 and three from Step 8)
9+
- 4 comments on issues you didn’t create (one from Step 6 and three from Step 8)
10+
- 5 merged pull requests (one from Step 1, one from Step 6, and three from Step 8)
811

912
<style><!--
1013
.dropbtn {

0 commit comments

Comments
 (0)