From f09d339dea0da6483aff609eb93130437f171761 Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Thu, 2 Nov 2023 22:53:41 -0400 Subject: [PATCH] docs: Add content about the guidelines for internship (#71) --- mkdocs.yml | 11 ++- pages/programs/internship/cycles/2023-01.md | 15 +++- .../internship/guides/interns/index.md | 86 +++++++++++++++++++ .../internship/guides/mentors/index.md | 72 ++++++++++++++++ pages/programs/internship/index.md | 2 +- 5 files changed, 178 insertions(+), 8 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index d5c4065e..92ee03e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,12 +25,11 @@ nav: - Affiliation: 'programs/affiliation/index.md' - Ambassadors: 'programs/ambassadors/index.md' - Incubator: 'programs/incubator/index.md' - - Internship: 'programs/internship/index.md' - # - Internship: - # - index: 'programs/internship/index.md' - # - "Mentors' Guide": 'programs/internship/guides/mentors/index.md' - # - "Interns' Guide": 'programs/internship/guides/interns/index.md' - # - "Cycle 2023-01": 'programs/internship/cycles/2023-01.md' + - Internship: + - index: 'programs/internship/index.md' + - Interns Guide: 'programs/internship/guides/interns/index.md' + - Mentors Guide: 'programs/internship/guides/mentors/index.md' + - "Cycle 2023-01": 'programs/internship/cycles/2023-01.md' - Mentoring: 'programs/mentoring/index.md' - "Package Support": 'programs/packaging-support/index.md' - Partners: 'programs/partners/index.md' diff --git a/pages/programs/internship/cycles/2023-01.md b/pages/programs/internship/cycles/2023-01.md index cda2065a..e575014f 100644 --- a/pages/programs/internship/cycles/2023-01.md +++ b/pages/programs/internship/cycles/2023-01.md @@ -6,4 +6,17 @@ authors: ["OSL Team"] template: single-sidebar.html --- -# Internship Program 2023 - 01 +# Internship Program Cycle 2023-01 + +## Participating Projects + +Below is a list of projects that is current participating in the cycle 2023-01 + +| Repository Name | Description | +| ---------------------------------- | ---------------------------------------------------- | +| conda-forge-warning | A panel that shows packages from conda-forge with no maintenance activities | +| satellite-weather-downloader | A system for downloading, transforming and analysing Copernicus weather data using Xarray. | +| makim | Make Improved | +| containers-sugar | Simplify the usage of containers | +| fqlearn | A graphic solver tool to teach mass transfer and thermodynamics. | +| pydatastructs | PyDataStructs aims to be a Python package for various data structures and algorithms (including their parallel implementations). | diff --git a/pages/programs/internship/guides/interns/index.md b/pages/programs/internship/guides/interns/index.md index d185ba1e..9669c059 100644 --- a/pages/programs/internship/guides/interns/index.md +++ b/pages/programs/internship/guides/interns/index.md @@ -5,3 +5,89 @@ date: "2023-10-30" authors: ["OSL Team"] template: single-sidebar.html --- + +# Open Science Labs Intern/Apprentice Guide + +Welcome to the Open Science Labs Internship/Apprenticeship Program Guide. This +comprehensive document is your gateway to engaging with a network of +professionals and peers dedicated to the advancement of open science and open +source. Whether you're considering applying to our program or you've already +been accepted, this guide is designed to facilitate a smooth transition into our +collaborative environment. You'll find detailed instructions on how to apply, +connect with mentoring organizations, and make the most of your internship once +you're on board. It's more than just an internship—it's a chance to contribute +to a global movement and develop skills that will serve you throughout your +career. Let's embark on this exciting journey together. + +## Part I: Prospective Candidates + +Embarking on the journey to become an intern or apprentice with Open Science +Labs is a step towards significant personal and professional development. This +part of the guide is tailored to assist you in navigating the application +process seamlessly. It provides insights on how to identify and select a project +that resonates with your passion, how to engage with mentors proactively, and +how to make preliminary contributions that will set you apart. Let's get started +on a path that leads to growth and exciting opportunities in open science and +technology. + +### 1. How to Apply + +#### 1.1. Choosing a Mentoring Organization and Project + +Begin by exploring the list of available mentoring organizations and their +projects. Look for one that aligns with your interests and skills. + +#### 1.2. Initiating Contact with Projects and Mentors + +Reach out to the project mentors via the contact information provided. Introduce +yourself, express your interest, and ask any initial questions you may have +about the project or the mentoring process. + +#### 1.3. Making a Small Contribution + +Demonstrate your commitment by making a small contribution to the project. This +could be fixing a minor bug, improving documentation, or any other task as +suggested by the mentor. + +#### 1.4. Crafting a Proposal with Mentor Support + +With your mentor's guidance, develop a detailed proposal outlining what you aim +to achieve during the internship. This should include specific milestones, a +timeline, and how your work will contribute to the project's goals. + +**Note on Mentor Evaluation**: Mentors will assess if candidates possess the +basic requirements to contribute effectively to the project. Transparent +feedback will be provided, allowing candidates to shift to another project if +necessary to ensure a suitable fit. + +## Part II: Approved Interns/Apprentices + +Congratulations on being selected as an intern or apprentice! This part of the +guide will serve as a roadmap to your success in the Open Science Labs program. +It outlines the expectations for your collaboration with mentors, the importance +of communication, and the coding standards you should follow. You will find tips +on how to maintain an effective workflow, stay proactive, and ensure that your +contribution leaves a lasting impact. Welcome to the team — your proactive +journey starts here. + +### Effective Workflow and Proactivity + +Once accepted, establish a regular workflow with your mentor. Be proactive: seek +out tasks, ask questions, and push beyond the basics. Set up frequent check-ins +and be clear about what you aim to accomplish each week. + +### Communication Best Practices + +Clear and timely communication is essential. Keep your mentor updated on your +progress, challenges, and any assistance you may require. Use the communication +tools preferred by the project for all discussions. + +### Programming Best Practices + +Adhere to the programming standards and best practices recommended by your +mentor and the project. Write clean, well-documented, and maintainable code. Be +open to code reviews and feedback, as they are learning opportunities. + +By following these guidelines, both candidates and approved interns/apprentices +can maximize their growth, contributions, and overall experience within the Open +Science Labs Internship/Apprenticeship Program. diff --git a/pages/programs/internship/guides/mentors/index.md b/pages/programs/internship/guides/mentors/index.md index d185ba1e..3431781b 100644 --- a/pages/programs/internship/guides/mentors/index.md +++ b/pages/programs/internship/guides/mentors/index.md @@ -5,3 +5,75 @@ date: "2023-10-30" authors: ["OSL Team"] template: single-sidebar.html --- + +# Open Science Labs Mentor Guide + +The Open Science Labs Mentor Guide is a consolidated resource designed to guide +potential mentoring organizations through the proposal and application process, +and to support approved mentors in fostering intern development. From project +submission to nurturing intern growth, and facilitating their successful +contributions to open source, this guide outlines the key steps and best +practices to ensure a rewarding mentorship experience in our community-driven +programs. + +## Part I: Applying to Become a Mentoring Organization + +As a prospective mentoring organization within Open Science Labs, you have the +opportunity to shape the future of open source by guiding and nurturing new +talent. Your contributions, in the form of project ideas and mentorship, are +crucial to the development of both individual contributors and the larger +community. This section of the guide will walk you through the application +process and help you submit your project proposals effectively. + +### Application Process + +When the call for mentoring organizations opens, you are encouraged to apply +with a detailed outline of all the project ideas. A 'project' constitutes a +well-defined proposal targeting a specific software, package, or library with +distinct tasks. While there is no limit to the number of projects you can +propose, please note that OSL reserves the right to approve only a subset based +on our capacity and strategic focus. For Cycle 2, tied to GSoC, a maximum of two +projects may be submitted per organization. + +**Important Note**: Inclusion in GSoC for Cycle 2 is not a certainty, and OSL +will provide updates on this option once GSoC confirmations are received. + +## Part II: Recommendations for Approved Mentors + +Congratulations on being selected as a mentor for the OSL +Internship/Apprenticeship Program! You are about to embark on a rewarding +journey of imparting knowledge and facilitating growth. This part of the guide +is crafted to support you in leading an effective mentorship, outlining key +activities and providing practical tips for fostering a successful internship +experience. + +### Conducting Effective Mentorship + +- **Proposal Guidance**: Assist the intern candidate in drafting a comprehensive + proposal for the program, detailing expected tasks and outcomes. +- **Regular Meetings**: Schedule consistent meetings (weekly or biweekly) with + the intern to discuss progress, challenges, and next steps. +- **PR Reviews and Direction**: Regularly review the intern's pull requests to + ensure they're aligned with the project's direction and maintain progress + within set timelines. +- **Blog Post Guidance**: Guide the intern in documenting their journey by + writing biweekly or monthly blog posts on https://opensciencelabs.org, + highlighting accomplishments and learnings. +- **Timeline Management**: Keep the intern informed of all important dates and + ensure they complete evaluations on time. +- **Presentation Preparation**: Support the intern in preparing a talk about + their project, which can be delivered within the OSL community or at relevant + events. + +### Additional Tips + +- **Extra Resources**: If an intern is struggling with certain concepts, + recommend additional study materials to aid their understanding. +- **Technical Advice**: Offer technical insights to enhance the intern's + performance and productivity, ensuring they contribute high-quality work to + the project. + +Mentoring with OSL is not just about overseeing work; it's about nurturing a new +generation of open source contributors. Your wisdom, experience, and +encouragement will help interns realize their potential and ensure they make a +meaningful impact on the open source community. diff --git a/pages/programs/internship/index.md b/pages/programs/internship/index.md index 9f350ea3..8dffc7c5 100644 --- a/pages/programs/internship/index.md +++ b/pages/programs/internship/index.md @@ -3,7 +3,7 @@ title: "OSL Internship Program" description: "Internship Program about" date: "2023-08-24" authors: ["OSL Team"] -# template: single-sidebar.html +template: single-sidebar.html --- # Open Science Labs Internship Program