diff --git a/docs/README.md b/docs/README.md index 1a31a1c..fd937f1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,18 +2,20 @@ The **Rensselaer Center for Open Source** - or **RCOS** (*`ar-kos`*) for short - is a community of motivated students at [Rensselaer Polytechnic Institute](http://rpi.edu) who develop open source projects under the guidance of experienced instructors and student mentors. -### Our Mission Statement +## Our Mission Statement > To cultivate an inclusive, creative, and entrepreneurial community that seeks to empower students to develop open-source solutions to real-world problems. -### What do we do? -RCOS members collaborate on open source projects throughout the semester. Members may participate as students pursuing free elective course credit, or recreationally for experience. At the beginning of each semester, members may propose an outline for a new or existing project, or join a project proposed by another member. Members enrolled for credit must regularly be in attendance, produce regular progress updates, and give a final presentation. +## What do we do? -All members are encouraged to produce successful projects, but the primary goals are to be exposed to interesting ideas, technologies, and people while gaining practical experience outside of the classroom in a low-risk environment. +RCOS members collaborate on open-source projects throughout the semester. Members may participate as students pursuing free elective course credit or recreationally for experience. At the beginning of each semester, members may propose an outline for a new or existing project or join a project proposed by another member. Members enrolled for credit must regularly be in attendance, produce regular progress updates, and give a final presentation. -RCOS is the first student run organization to be accepted as an associate member of the [Open Source Initiative](https://opensource.org/). With an semesterly membership of ~200 students and over 1000 alumni, RCOS is the largest open source campus organization in the country. +All members are encouraged to produce successful projects. Still, the primary goals are to be exposed to interesting ideas, technologies, and people while gaining practical experience outside the classroom in a low-risk environment. + +RCOS is the first student-run organization accepted as an associate member of the [Open Source Initiative](https://opensource.org/). With a semesterly membership of ~400 students and over 1000 alums, RCOS is the largest open-source campus organization in the country. Check out the [FAQ](overview/faq.md?id=main) for more information. -### RCOS Handbook -This handbook is the single-source-of-truth of documentation for RCOS. It is intended to be a thorough, living document detailing the organizational practices of RCOS at every level. If you find a problem or something that you'd like to dispute, please [open an issue](https://github.com/rcos/handbook/issues/new). You can learn more about this handbook [here](handbook/README.md). +## RCOS Handbook + +This handbook is the single source of truth of documentation for RCOS. It is intended to be a thorough, living document detailing the organizational practices of RCOS at every level. If you find a problem or something you'd like to dispute, please [open an issue](https://github.com/rcos/handbook/issues/new). You can learn more about this handbook [here](handbook/README.md). diff --git a/docs/meetings/inclement_weather.md b/docs/meetings/inclement_weather.md index e275e44..f0f79e3 100644 --- a/docs/meetings/inclement_weather.md +++ b/docs/meetings/inclement_weather.md @@ -2,25 +2,27 @@ ## Overview -We at RCOS understand that it may be difficult or unsafe to get to campus during inclement weather. Below are our policies on cancelling or dismissing RCOS meetings due to inclement weather. +We at RCOS understand that getting to campus during inclement weather may be difficult or unsafe. Below are our policies on canceling or dismissing RCOS meetings due to inclement weather. ## Weekday Meetings and Events -If classes are not in session due to inclement weather, any RCOS events that occur during that day will also be cancelled. These events include: -- Large Group -- Friday Workshops -- Small Group -- Weekday Work/Bonus Sessions -Large Groups that are cancelled might be rescheduled to another RCOS period to make up. +If classes are not in session due to inclement weather, any RCOS events during that day will also be canceled. These events include: + +- Large Group Meetings +- Small Group Meetings +- Workshops + +Large Groups that are canceled might be rescheduled to another RCOS period to make up. ## Weekend or Holiday Events -If RPI's shuttle service or Safe Ride program is suspended due to inclement weather when classes are not in session, any RCOS events occurring on that day will be cancelled. This includes: +If RPI's shuttle service or Safe Ride program is suspended due to inclement weather when classes are not in session, any RCOS events occurring that day will be canceled. This includes: + - Weekend work sessions - Code Jams - RCOS Hackathons - Weekend bonus sessions -If a shuttle service or Safe Ride suspension is announced during an RCOS event, event hosts reserve the right to dismiss the event early so that attendees can get home safely. +If a shuttle service or Safe Ride suspension is announced during an RCOS event, event hosts reserve the right to dismiss the event early so attendees can get home safely. -In the final 3 weeks of the Fall semester and the first half of the Spring semester, event hosts are encouraged to set aside a "snow date" for any code jams, hackathons, or weekend bonus sessions. +In the final three weeks of the Fall semester and the first half of the Spring semester, event hosts are encouraged to set aside a "snow date" for any code jams, hackathons, or weekend bonus sessions. diff --git a/docs/meetings/large_group_meetings.md b/docs/meetings/large_group_meetings.md index 0447275..185368f 100644 --- a/docs/meetings/large_group_meetings.md +++ b/docs/meetings/large_group_meetings.md @@ -1,27 +1,26 @@ # Large Group Meetings -!> We are still adapting to the return to restricted in-person courses. This information may change. - ## Overview -Large Group is when the entirety of RCOS gathers for announcements, guest speakers, town hall meetings, or opening/closing ceremonies. +Large Group is when the entirety of RCOS gathers for announcements, guest speakers, town hall meetings, or opening/closing ceremonies. ## Time and Frequency + During the first two weeks of the semester, Large Group occurs every Tuesday and Friday to get new community members acquainted with RCOS and to inform existing members on changes in structure and mentorship. -Once all community members are assigned to a Small Group, Large Group will only occur on one or two Fridays per month. All other Fridays are reserved for Small Group meetings. +Once all community members are assigned to a Small Group, Large Group will only occur at the end of the Summer. All other Fridays are reserved for Small Group meetings. -Large group will also occur on the last Friday of the semester for our closing ceremony. +Large Group will also occur on the last Friday of the semester for our closing ceremony. ## Announcements -Each Large Group meeting's slides have an announcements section where Coordinators/Faculty Advisors announce important events both in RCOS and external. RCOS members who have interesting announcements about external events or anything else they feel worth sharing with everyone can ask a Coordinator to briefly talk during the Large Group meeting. Don't be hesitant to, we heavily encourage participation! We take note of particularly engaged RCOS members. + +Each Large Group meeting's slides have an announcements section where Coordinators/Faculty Advisors announce important events both in RCOS and externally. RCOS members with interesting announcements about external events or anything else they feel worth sharing with everyone can ask a Coordinator to talk briefly during the Large Group meeting. Don't be hesitant to; we heavily encourage participation! We take note of particularly engaged RCOS members. ## Guest Speakers -!> We currently are not allowed to host visitors on campus, so guest speakers would dial in to meetings through WebEx. -RCOS welcomes guest speakers to present their work or research and how it encorporates open-source software. Every once in a while a guest speaker will be given time to present during a Large Group meeting for everyone. These can be anyone from RPI faculty to external companies. These will be announced ahead of time. Guest speakers presentations generally should not be longer than 40 minutes. +RCOS welcomes guest speakers to present their work or research and how it incorporates open-source software. Occasionally, a guest speaker will be given time to present during a Large Group meeting for everyone. These can be anyone from RPI faculty to external companies. These will be announced ahead of time. Guest speaker presentations generally should be at most 40 minutes. ## End of Year Closing Ceremony + - Coordinators select 2-3 projects to give a very brief highlights reel on their accomplishments in the semester - New Coordinators are introduced -- ~~Pizza is delivered for everyone~~ ;( diff --git a/docs/meetings/semester_outline.md b/docs/meetings/semester_outline.md index 90d7628..481df0e 100644 --- a/docs/meetings/semester_outline.md +++ b/docs/meetings/semester_outline.md @@ -2,40 +2,35 @@ ## Summary -Each RCOS semester is standalone. The first few weeks are used for setting up mentors, Small Groups, and projects. The middle of the semester - the majority - is spent working on your projects. The last few weeks of the semester are dedicated to final project presentations and wrap up. +Each RCOS semester is standalone. The first few weeks are used for setting up mentors, Small Groups, and projects. The middle of the semester - the majority - is spent working on your projects. The last few weeks of the semester are dedicated to final project presentations and wrap-up. ## Semester Start -- Mentors/Coordinators Announced +This is usually the first two weeks of the semester. +- Mentors/Coordinators Announced - Project Formation - - Project pitches - Project pairing - Project proposals - - Projects Grouped into Small Groups - Mentors assigned ## Mid Semester -- Small Group Meetings Start +This is usually the bulk of the semester. +- Small Group Meetings Start - Project Contributions Start - - Workshops Start - -- Midyear Review +- Mid-Semester Commit Summary ## Semester End -- Last Contributions Submitted +This is usually the last two weeks of the semester. +- Last Contributions Submitted - Final Presentations - -- End of Year Review - - - Pizza?? - +- Final Commit Summary - Final Grading - Grade appeals diff --git a/docs/meetings/small_group_meetings.md b/docs/meetings/small_group_meetings.md index 977d778..6c5bd00 100644 --- a/docs/meetings/small_group_meetings.md +++ b/docs/meetings/small_group_meetings.md @@ -1,18 +1,21 @@ # Small Group Meetings -!> We are still adapting to the return to restricted in-person courses. This information may change. - ## Overview -Small Group meetings are where the majority of RCOS project work gets done. Once projects are finalized at the start of the semester, projects are grouped into Small Groups overseen by a Mentor or two and are assigned to a room, typically in Sage. During Small Group meetings, you have time to work and discuss with your team, collaborate with other projects, and get help from your Mentor(s). + +Small Group meetings are where the majority of RCOS project work gets done. Once projects are finalized at the start of the semester, projects are grouped into Small Groups overseen by a Mentor or two and are assigned to a room. During Small Group meetings, you have time to work and discuss with your team, collaborate with other projects, and get help from your mentor (s). ## Time and Frequency -Small Group meetings take place during regularly schedule RCOS sections on Tuesdays and Fridays from 4pm to 5:50pm. Attendance is required, with details listed [here](grading/attendance). Members are expected to work for the majority of the period. Attendance is generally taken after an hour and a half to ensure members are coming and staying. + +Small Group meetings occur during regularly scheduled RCOS sections on Tuesdays and Fridays from 4 pm to 5:50 pm. Attendance is required, with details listed [here](grading/attendance). Members are expected to work for the majority of the period. Attendance is generally taken after an hour and a half to ensure members come and stay. ## Location -Small Groups are assigned to small rooms, typically in Russell Sage Laboratory. Each Small Group (and project) is also given their own Discord voice and text channels on the server which they are encouraged to actively use. + +Small Groups are assigned to small rooms. On average, these locations hold around 30 people, so that a few projects will be in each room. Each project is also given its own Discord voice and text channels on the server, which they are encouraged to use actively. ## Agenda -Your Mentor(s) will run the Small Group meeting. It will start with a short presentation prepared by the Coordinators to give general RCOS announcements and updates. Then the agenda is up to the Mentor(s), though the majority of the time will always be given to Open Hacking (see below). Mentors are required to keep up-to-date on your projects so they might do this by having a standup where everyone in the room quickly recounts their progress and blockers, or they might speak individually to projects and team members. + +Your mentor(s) will run the Small Group meeting. It will start with a short presentation prepared by the Coordinators to give general RCOS announcements and updates. Then, most of the time, it will always be given to Open Hacking (see below). Mentors are required to keep up-to-date on your projects, so they might do this by having a standup where everyone in the room quickly recounts their progress and blockers, or they might speak individually to projects and team members. ## Open Hacking -The majority of Small Group meeting time should be actual development work on your project. This is when project leads can directly speak with the whole team, delegate tasks, troubleshoot, and manage their project. Mentors can be called in if available to help with technical blockers. + +Most Small Group meeting time should be actual development work on your project. This is when project leads can directly speak with the whole team, delegate tasks, troubleshoot, and manage their project. Mentors can be called in if available to help with technical blockers. diff --git a/docs/membership/join_rcos.md b/docs/membership/join_rcos.md index e5ef36b..7cadf0a 100644 --- a/docs/membership/join_rcos.md +++ b/docs/membership/join_rcos.md @@ -2,23 +2,23 @@ ## RPI Students -RCOS runs each semester of the school year, including summer semesters. You can participate either by either taking the course for credit or no credit. If you take RCOS for credit, you must meet all of the requirements described in [Grading](grading/README) in order to receive a grade. If not taking for credit, you can participate in the same way but are not held to any requirements. +RCOS runs each semester of the school year, including summer semesters. You can participate by taking the course for credit or no credit. If you take RCOS for credit, you must meet the requirements described in [Grading](grading/README) to receive a grade. If not taking for credit, you can participate in the same way but are not held to any requirements. ### 1. Register for the RCOS Course -When course registration opens, search for RCOS in QuACS or YACS and register for the section that has the number of credits you want to take RCOS for. The credit count is factored into grading. You will also be able to show up to the first RCOS meeting of the semester and register via SIS then, but it is best to do this as soon as possible! +When course registration opens, search for RCOS in QuACS or YACS and register for the section with the number of credits you want to take RCOS with. The credit count is factored into grading. You will also be able to show up to the first RCOS meeting of the semester and register via SIS, but it is best to do this as soon as possible! If you have a conflict, contact the faculty advisors for help! -### 2. Register on Telescope +### 2. Register on new.rcos.io -Log into [Telescope](https://rcos.io) with CAS to register as an RCOS member in our database. +[Sign up at our website](https://new.rcos.io/) to register as an RCOS member in our database. You will initially sign up via email, but you can connect your personal Discord and GitHub profiles as alternate ways to sign in. -### 3. Join Discord Server +### 3. Join our Discord Server -RCOS uses Discord for all communication. It is required that you join the RCOS Discord server for updates, announcements, and team communication throughout the semester. Once you have logged into Telescope, [connect your Discord account](https://rcos.io/link/discord) which will add you to the Discord server. Here, you'll be able to reach out to Faculty Advisors, Coordinators, Mentors, and your fellow members! +RCOS uses Discord for all communication. You must join the RCOS Discord server for updates, announcements, and team communication throughout the semester. Once you have logged into our website, [connect and link your Discord account](https://new.rcos.io/profile/) on your profile page. This should add you to the Discord server. Here, you can reach out to Faculty Advisors, Coordinators, Mentors, and your fellow members! **If you need help with this, contact a faculty advisor or a coordinator ASAP to be added.** ### 4. Attend First Meeting -The first RCOS meeting of each semester is on either the first Tuesday or Friday of the semester at 4pm. Typically these large meetings take place in DCC 318, but always check SIS for the actual location! +The first RCOS meeting of each semester is on either the first Tuesday or Friday of the semester at 4 pm. Typically, these large meetings occur in DCC 318, but always check SIS for the actual location! diff --git a/docs/membership/project_pairing.md b/docs/membership/project_pairing.md index 776bff6..2d7f573 100644 --- a/docs/membership/project_pairing.md +++ b/docs/membership/project_pairing.md @@ -1,7 +1,5 @@ # Project Pairing -!> We are still adapting to the return to restricted in-person courses. This information may change. - ## Overview The goal of Project Pairing is to ensure that each student finds a project that matches their interests. Finding a project can be very nerve-wracking, especially for new members. Project Pairing was introduced to address this problem. diff --git a/docs/membership/requirements.md b/docs/membership/requirements.md index c199741..3a855b9 100644 --- a/docs/membership/requirements.md +++ b/docs/membership/requirements.md @@ -1,36 +1,42 @@ # What You'll Need All RCOS students will need a few belongings to succeed: + - Computer with internet (recommended specifications below) - [Git installation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) For software-based projects: + - Text editor or IDE ## Learn Git -[Git](https://git-scm.com/) is a version control/collaboration system that is extremely popular among open source projects. To contribute in RCOS, you WILL need to learn to use git (it's not that bad). Try taking [github's git tutorial](https://try.github.io/levels/1/challenges/1). +[Git](https://git-scm.com/) is an extremely popular version control/collaboration system among open-source projects. To contribute in RCOS, you **WILL** need to learn to use Git (it's not that bad). Try taking [github's git tutorial](https://github.com/git-guides). You can read more about Git and related resources on [this page](resources/README.md#RCOS-Essentials)! ## Recommendations ### Operating Systems -If you choose to work in a code-intensive role, we highly recommend a Unix-based operating system. + +We highly recommend a Unix-based operating system if you choose to work in a code-intensive role. If you have a Mac, you're all set! Your next step is to familiarize yourself with the terminal if you haven't already. -If you have a Windows PC, we highly recommend using a Linux distribution such as Ubuntu through WSL. This will give you access to Linux tools, applications, and the command line while staying on your Windows device! Follow this [guide](https://www.omgubuntu.co.uk/how-to-install-wsl2-on-windows-10). +We highly recommend using a Linux distribution such as Ubuntu through WSL if you have a Windows PC. This will give you access to Linux tools, applications, and the command line while staying on your Windows device! [Follow this guide](https://www.omgubuntu.co.uk/how-to-install-wsl2-on-windows-10). ### Text Editors and IDEs + - [Visual Studio Code](https://code.visualstudio.com/) - all-purpose IDE - [Xcode](https://developer.apple.com/xcode/) - Mac-only, recommended for iOS development - [Sublime Text](https://www.sublimetext.com/) - minimalist, flexible, easy to use even for beginners -- [Atom](https://atom.io/) - very customizable, very GitHub friendly -- [Vim](https://www.vim.org/) - terminal-based text editor, very barebones (recommended for Raspberry Pi projects as you may not be able to access Sublime on a Pi) +- [Vim](https://www.vim.org/) - terminal-based text editor, very bare bones (recommended for Raspberry Pi projects as you may not be able to access Sublime on a Pi) + +You can learn more about Text Editors and IDEs on the [student resources page](resources/README.md#ides-and-code-editors). -### Windows Recommendations -- [Docker](https://www.docker.com/products/docker-desktop) -- [VirtualBox](https://www.virtualbox.org/) -- [GitHub Desktop](https://desktop.github.com/) +### Software Recommendations + +- [Docker](https://www.docker.com/products/docker-desktop) - Packs your apps in portable containers for easy deployment across different environments. +- [VirtualBox](https://www.virtualbox.org/) - Creates virtual machines on your computer, perfect for running multiple operating systems. +- [GitHub Desktop](https://desktop.github.com/) - Simplifies version control with a user-friendly interface for Git, aiding collaboration and code management. diff --git a/docs/overview/contact.md b/docs/overview/contact.md index c4ccb35..6d90752 100644 --- a/docs/overview/contact.md +++ b/docs/overview/contact.md @@ -7,12 +7,13 @@ ## Social Media - [RCOS](https://www.github.com/rcos) +- [Blog](https://blog.rcos.io/) - [Facebook](https://www.facebook.com/RCOSatRPI) - [Twitter](https://twitter.com/rcosrpi) ## Affiliates -- [Mozilla Open Source Student Network](https://opensource.mozilla.community/find-club/rensselaer-center-open-source-rcos/) +- [Open Source Initiative](https://opensource.org/affiliates/) - [RPI Web Technologies Group](https://webtech.union.rpi.edu/) - [RPISec](https://rpis.ec/) - [RPI UPE](http://www.cs.rpi.edu/~upe/) diff --git a/docs/overview/faq.md b/docs/overview/faq.md index e4fea63..8ff2bf2 100644 --- a/docs/overview/faq.md +++ b/docs/overview/faq.md @@ -1,28 +1,37 @@ # Frequently Asked Questions ## What do you do in RCOS? -In a semester of RCOS, you work with a team (or solo) on an open source project. You can either start your own project and manage a team of students, or join a project and work under a project lead. + +In a semester of RCOS, you work with a team (or solo) on an open-source project. You can either start your own project and manage a team of students or join an existing project and work under a project lead. ## What kind of course credit can you receive? -You can register for RCOS for any amount of free elective credits. You can also take RCOS for 0 credits - for experience only - for no obligation for attendance and contributions. + +You can register for RCOS for any amount of free elective credits. You can also take RCOS for 0 credits - for experience only - without obligation for attendance, contributions, and final presentations. ## How often does RCOS meet? -RCOS meets twice each week for two hours on Tuesdays and Fridays, typically from 4pm to 6pm, where attendance is required. There are also other one-off meetings and events held throughout the semester where attendance is optional. + +RCOS meets twice weekly for two hours on Tuesdays and Fridays, typically from 4 pm to 6 pm, where attendance is required. Other one-off workshops and events are held throughout the semester, where attendance is optional. ## How much time is expected per week? -You are expected to work on your RCOS project for, at minimum, the 4-hours a week that the course meets. If you are taking RCOS for credit, you are expected to work for a few more hours each week based on your credit count. If you are taking RCOS for no credit, you are encouraged to work consistently each week but are under no obligation to do so. + +You are expected to work on your RCOS project for, at minimum, the 4-hours a week that the course meets. If you take RCOS for credit, you are expected to work a few more hours each week based on your credit count. If you take RCOS for no credit, you are encouraged to work consistently weekly. Still, you are under no obligation to do so. ## What kind of projects can I work on? -The only requirement for an RCOS project is that it be open source. While we mostly have software projects, hardware projects are welcome and encouraged. Projects range from full stack web apps, native applications, mobile applications, video games, programming languages, and more. Check out [rcos.io/projects](https://rcos.io/projects) for a full list! + +The only requirement for an RCOS project is that it be open source. While we mostly have software projects, hardware projects are welcome and encouraged. Projects range from full-stack web apps, native applications, mobile applications, video games, programming languages, and more. Check out [new.rcos.io/projects](https://new.rcos.io/projects/) for the complete list of projects! ## Do I have to finish my project? + No! RCOS looks for consistent work, not a fully-fledged, completed project at the end of the semester. You are graded by how consistently you worked with your team towards the milestones you set at the start of the semester. We recognize plans change and sometimes fail! As a result, you can work on the same project multiple semesters, and we encourage project leads to do so. ## Do I need Computer Science experience to join? -You do not need any prior programming/hardware/CS experience to join RCOS and all majors are welcome. However, different projects will require different levels of experience from their members. There are often many projects each semester that welcome beginners and are willing to teach members how to get started and contribute. There are also workshops held by members throughout each semester on different technologies, frameworks, languages, etc. to learn from. We strongly encourage at least CS1 experience for those getting started RCOS. Students who have taken Data Structures + +You do not need prior programming/hardware/CS experience to join RCOS; all majors are welcome. However, different projects will require different levels of experience from their members. Often, many projects each semester welcome beginners and are willing to teach members how to get started and contribute. There are also workshops held by members throughout each semester on different technologies, frameworks, languages, etc., to learn from. We strongly encourage at least CS1 experience for those getting started with RCOS. ## What are some successful RCOS projects? -[YACS](https://github.com/YACS-RCOS), in development since 2010, lets students create course schedules. [Venue](https://github.com/TheStopsign/Venue) is a classroom management tool that integrates QR Code based attendance and enforces asynchronous lecture recording playback. [PollBuddy]([https://github.com/observatory-server](https://pollbuddy.app/) is RCOS's primary attendance tool. + +[YACS](https://yacs.cs.rpi.edu/), in development since 2010, lets students create course schedules. Another well-known course scheduler is [Quacs](https://quacs.org/). [LEGUP](https://github.com/Bram-Hub/LEGUP) is a better way to learn formal logic. [Shuttle Tracker](https://web.shuttletracker.app/) is RPI's primary source for shuttle locations. ## Why is RCOS a unique RPI organization? -RCOS is a student-run organization that allows students to not only work on what interests them, but also to receive course credit for it. + +RCOS is a student-run organization that allows students to work on what interests them and receive course credit for it. diff --git a/docs/overview/history.md b/docs/overview/history.md index caefeec..8f189db 100644 --- a/docs/overview/history.md +++ b/docs/overview/history.md @@ -9,7 +9,7 @@ -### Overview +## Overview RCOS was founded in 2006 by a generous $2M donation from [Sean O'Sullivan](https://sosf.us/rensselaer/). Past and current leadership: @@ -52,7 +52,7 @@ The program gained momentum in 2007 with launch of Open Source Software course. -### RedHat Funding (2014-2015) +## RedHat Funding (2014-2015) Thrust: To improve the overall quality of RCOS projects and to increase diversity @@ -61,7 +61,7 @@ Thrust: To improve the overall quality of RCOS projects and to increase diversit - Funds the development of two (one CS and one HASS) freshmen/sophomore-level courses on Open Source - Funds Undergraduate Mentors for two new courses -### RedHat Funding (contd) +## RedHat Funding (contd) - Diversity Hackathon - April 16-17, 2016 - Primarily Hackathon for women students in Capital District universities, colleges and high schools