diff --git a/docs/_sidebar.md b/docs/_sidebar.md index f344afe..090ffc5 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,6 +1,7 @@ - Overview - [Welcome to RCOS](README.md) + - [One Page Unofficial Syllabus](overview/one_page.md) - [FAQ](overview/faq.md) - [History](overview/history.md) - [Code Of Conduct](overview/code_of_conduct.md) diff --git a/docs/overview/one_page.md b/docs/overview/one_page.md new file mode 100644 index 0000000..1faa5c0 --- /dev/null +++ b/docs/overview/one_page.md @@ -0,0 +1,235 @@ +# One Page Unofficial Syllabus + +This is the unofficial "syllabus" for the RCOS Spring 2024 Semester. This was made so students have easy and quick access to the most important information about RCOS like: what rcos is, faculty advisor names and contact information, student grade rubric, Mentor grade rubric, a brief semester outline, learning outcomes, and finally academic policies. + +## What is RCOS? + +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 + +> 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. + +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. + +## Faculty & Coordinators + +As of Spring 2024 these are the current Faculty Advisors and Coordinators, along with their emails and discord usernames. + +### Faculty Advisors + +- Professor Wes Turner - Email: turnew2@rpi.edu | Discord: prof.turner +- Professor Konstantin Kuzmin - Email: kuzmik2@rpi.edu | Discord: main.sparky +- Professor Neha Keshan - Email: Keshan@rpi.edu | Discord: tiger93 +- Professor Yanglet (Xiao-Yang) Liu - Email: liux33@rpi.edu | Discord: yanglet +- Professor Jidong Xiao - Email: xiaoj8@rpi.edu +- Professor David Goldschmidt - Email: goldsd3@rpi.edu + +### Coordinators + +- Anugraha Awasthi - Email: awasta@rpi.edu | Discord: webex.exe +- Siggy Nazimowitz - Email: nazime@rpi.edu | Discord: sigalit +- Jacob Weber - Email: weberj5@rpi.edu | Discord: jaw12346 +- Michael Anderson - Email: anderm18@rpi.edu | Discord: officialpie +- Anthony Fabius - Email: fabiua@rpi.edu | Discord: coup1799 +- Samir Beall - Email: bealls@rpi.edu | Discord: vondeeble + +## Grading Rubric for Students + +### 50% - Open Source Contributions + +RCOS is, at heart, about participation in the Open Source Ecosystem. + +| Grade | Description | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Makes numerous significant contributions. Student is active on GitHub and Discord and makes excellent use of issue tracking and project management systems. Student communicates failures and development barriers to their team and mentors and documents them for the future, and makes their best effort to overcome challenges. Open contributions are licensed correctly with an OSI approved license, are easy to find and can be easily obtained and used. Gives a Final Commit Summary that is a concise but complete summary of links to the year's contributions. | +| **B** | Makes multiple meaningful contributions to the project, but may be slightly lacking in communication and/or planning requirements, or may not make good use of issue tracking / project management systems. Open contributions are licensed correctly and can be easily obtained and used, but may not be easy to find. May not provide a final summary of links to contributions. | +| **C** | Makes too few contributions and does not ask for help when needed. Student makes little to no use of issue tracking and project management systems, and does not communicate well with team members or mentors. Open contributions may not be licensed correctly, may not be easily obtained and used, or may not be easy to find. May not provide a final summary of links to contributions. | +| **D** | Makes almost no meaningful contributions and makes little effort to communicate with team members and mentors, or contributions are not licensed correctly. May not provide a final summary of links to contributions. | +| **F** | Makes no visible effort to contribute to their project or communicate with their team and mentors. May not provide a final summary of links to contributions. | + +### 25% - Status Updates and Project Documentation + +Your community needs to know what you are working on and what you have accomplished, and we need to know that you are engaged throughout the semester. +Keeping us informed with a weekly status update and by keeping your project documentation up to date will help us and will allow us to give you the grade you deserve. + +| Grade | Description | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Submits the required number of high caliber status updates documenting each issue they work on and several problems they solve or investigate deeply. Project has a helpful README, and has additional documentation that is of quality and value. | +| **B** | Makes status updates that may be too few or brief OR project may not have may not have much additional documentation. Final status update is missing or does not fully capture the project status. | +| **C** | Makes only a few or low quality status updates, OR project may have little other documentation. | +| **D** | Makes few status updates of little to no value and does not contribute to other forms of documentation. | +| **F** | Makes no status updates and contributes no effort toward documenting the project. Project does not have a meaningful README or license. | + +### 15% - Presentations + +You need to develop the ability to represent yourself, your project and RCOS. +Presentations like the Final Presentation are critical to this learning goal. + +| Grade | Description | +| ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Participates in a well structured and interesting presentation and demonstrates a knowledge of what they worked on; is well prepared and clearly rehearsed. Represents RCOS externally. | +| **B** | Makes a reasonable effort to participate in presentation and is at least somewhat prepared. | +| **C** | Is unprepared for presentation or does not participate heavily. | +| **D** | Makes little effort to participate in presentation or gives a poor presentation. | +| **F** | Makes no effort to participate in presentation or does not attend. | + +### 10% - Attendance + +You cannot learn, participate, or share unless you are here. + +| Grade | Description | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Makes all required meetings and makes up all unexcused absences. Attends or gives at least two bonus sessions. | +| **B** | Misses no more than four meetings and makes up most unexcused absences. Attends two bonus sessions beyond those used to make up missed attendances. | +| **C** | Repeatedly misses meetings or does not make up unexcused absences. Does not attend additional bonus sessions. | +| **D** | Misses many meetings and does not attempt to make up unexcused absences. | +| **F** | Makes no effort to regularly attend meetings. | + +--- + +## Grading Rubric for Mentors + +Mentors have a unique responsibility within RCOS. As a mentor you are +expected to run a Small Group, be familiar with all the projects in your +group, fill out evaluations, provide guidance and technical support to +projects in your group, and to regularly attend mentor meetings. Because of this added responsiblity, you are given more leeway on the number of open source contributions as well as other rubric items below. + +At a minimum a mentor is **required** to host at least one workshop. + +### 50% - Open Source Contributions & RCOS Community Service + +RCOS is, at heart, about participation in the Open Source Ecosystem. *Mentorship includes contributing to the RCOS community.* + +| Grade | Description | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Makes significant contributions to open-source projects **and the RCOS organization**. This can include effective management of small-group rooms, marking student contributions, answering student questions, promoting RCOS externally, and generally allowing the RCOS organization to function as a strong component of the RPI campus. Student is active on GitHub and Discord and makes excellent use of issue tracking and project management systems. Student communicates failures and development barriers to their team and documents them for the future, and makes their best effort to overcome challenges. Open contributions are licensed correctly with an OSI approved license, are easy to find and can be easily obtained and used. Gives a Final Commit Summary that is a concise but complete summary of links to the semesters's contributions. | +| **B** | Makes multiple meaningful contributions to projects **and the RCOS organization**, but may be slightly lacking in communication and/or planning requirements, or may not make good use of issue tracking / project management systems. Open contributions are licensed correctly and can be easily obtained and used, but may not be easy to find. May not provide a final summary of links to contributions. Does a good job monitoring projects in their small group room but may occasionally miss the target with regard to project needs to open-source **and the RCOS organization**. Mentor is marginally effective monitoring their project groups and services to RCOS. | +| **C** | Makes too few contributions and does not ask for or provide help when needed. Small group room is not well run and students are not given help. Student makes little to no use of issue tracking and project management systems, and does not communicate well with team members or mentors. Open contributions may not be licensed correctly, may not be easily obtained and used, or may not be easy to find. May not provide a final summary of links to contributions. Is generally ineffective in providing guidance to their room and helping with management of RCOS. +|**D** | Makes almost no meaningful contributions to open-source and the RCOS organization, and makes little effort to communicate with students and coordinators, or contributions are not licensed correctly. Is not May not provide a final summary of links to contributions. Is generally ineffective monitoring their project groups and services to RCOS. Is generally ineffective in prviding guidance to their room and helping with magament of RCOS. | +| **F** | Makes no visible effort to contribute to their project or communicate with their team and mentors. May not provide a final summary of links to contributions. Does little to monitor their project groups and provide services to RCOS. Is not effective in prviding guidance to their room. | + +### 25% - Status Updates and Project Documentation + +Mentors help bridge communication between RCOS students and coordinators. Mentor-specific status updates serve as a way to keep coordinators aware of the general status of each room, projects that may be running into issues or facing blockers, as well as students notable for going above and beyond. + +These status updates specifically require, in addition to everything required in student status updates, updates on each project within the room and students that may require more help or attention. + + +| Grade | Description | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Submits the required number of high caliber status updates documenting each issue they work on and several problems they solve or investigate deeply. Project has a helpful README, and has additional documentation that is of quality and value. | +| **B** | Makes status updates that may be too few or brief OR project may not have may not have much additional documentation. Final status update is missing or does not fully capture the project status. | +| **C** | Makes only a few or low quality status updates, OR project may have little other documentation. | +| **D** | Makes few status updates of little to no value and does not contribute to other forms of documentation. | +| **F** | Makes no status updates and contributes no effort toward documenting the project. Project does not have a meaningful README or license. | + +### 15% - Presentations + +You need to develop the ability to represent yourself, your project and RCOS. +Presentations like the Final Presentation are critical to this learning goal. + +| Grade | Description | +| ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Participates in a well structured and interesting presentation and demonstrates a knowledge of what they worked on; is well prepared and clearly rehearsed. Represents RCOS externally. | +| **B** | Makes a reasonable effort to participate in presentation and is at least somewhat prepared. | +| **C** | Is unprepared for presentation or does not participate heavily. | +| **D** | Makes little effort to participate in presentation or gives a poor presentation. | +| **F** | Makes no effort to participate in presentation or does not attend. | + +### 10% - Attendance + +You cannot learn, participate, mentor, or share unless you are here. + +| Grade | Description | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| **A** | Attends all required classes and mentor meetings and makes up all unexcused absences. **Presents at least one workshop** and attends at least one workshop. | +| **B** | Misses no more than four mentor/class meetings and makes up most unexcused absences. **Presents at least one workshop** and attends at least one workshop. | +| **C** | Repeatedly misses mentor/class meetings or does not make up unexcused absences. Does not give any workshops. | +| **D** | Misses many meetings and does not attempt to make up unexcused absences. | +| **F** | Makes no effort to regularly attend meetings. | + +## Semester Outline + +### Semester Start + +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 + +This is usually the bulk of the semester. + +- Small Group Meetings Start +- Project Contributions Start +- Workshops Start +- Mid-Semester Commit Summary + +### Semester End + +This is usually the last two weeks of the semester. + +- Last Contributions Submitted +- Final Presentations +- Final Commit Summary +- Final Grading + - Grade appeals + +## Learning Outcomes + +- Students will gain practical experience in collaborative software development on real-world projects of their choosing +- Students will learn practical aspects of community driven software development +- Students will learn and apply the principles of open source on real life projects in an open environment +- Students will be given the opportunity to learn new technologies of their choosing and will need to develop capabilities to "self learn" new topic areas. + +## Academic Policies + +### Academic Integrity + +Student-teacher relationships are built on trust. For example, students must trust that teachers have made appropriate decisions about the structure and content of the courses they teach, and teachers must trust that the assignments that students turn in are their own. Acts that violate this trust undermine the educational process. The Rensselaer Handbook of Student Rights and Responsibilities and The Graduate Student Supplement define various forms of Academic Dishonesty and you should make yourself familiar with these. In this class, all assignments that are turned in for a grade must represent the student’s own work. In cases where help was received, or teamwork was allowed, a notation on the assignment should indicate your collaboration. + +Violations of academic integrity may also be reported to the appropriate Dean (Dean of Students for undergraduate students or the Dean of Graduate Education for graduate students, respectively). + +If you have any question concerning this policy before submitting an assignment, please ask for clarification. In addition, you can visit the following site for more information on our Academic Integrity Policy: [Students Rights, Responsibilities, and Judicial Affairs](https://info.rpi.edu/dean-students/student-rights-responsibilities-and-conduct). + +### Disability Services + +Rensselaer Polytechnic Institute strives to make all learning experiences as accessible as possible. If you anticipate or experience academic barriers based on a disability, please let me know immediately so that we can discuss your options. To establish reasonable accommodations, please register with The Office of Disability Services for Students. After registration, make arrangements with the Director of Disability Services as soon as possible to discuss your accommodations so that they may be implemented in a timely fashion. DSS contact information: dss@rpi.edu; +1-518-276-8197; 4226 Academy Hall. + +[Disability Services for Students](https://studenthealth.rpi.edu/list-services/disability-student-services) + +### Support Services + +[RPInfo](https://info.rpi.edu/) - contains various resource links for students, academic resources, support services, and safety & emergency preparedness. + +| Type | Service | Phone Number | Links | +|:---------------------------:|:----------------------------------------------------:|:------------:|:-----------------------------------------------------------------:| +| Academic Assistance | ALAC - Advising And Learning Assitance Center | 518-276-6269 | https://info.rpi.edu/advising-learning-assistance/ | +| Student Health and Wellness | Counseling Center | 518-276-6479 | https://studenthealth.rpi.edu/list-services/counseling-center | +| Student Health and Wellness | Student Health Center | 518.276.6287 | https://studenthealth.rpi.edu/list-services/student-health-center | +| Student Support Services | Class Deans, Undergraduate Dean, Graduate Experience | 518.276.8022 | https://success.studentlife.rpi.edu/ | +| Student Support Services | Dean, Student Success Dean, First Year Experience | 518.276.8022 | https://success.studentlife.rpi.edu/ | +| RPI Info | Central Information Hub for the campus | | https://info.rpi.edu/ | +| DOTCIO (IT Services) | Help Desk | 518.276.7777 | | +| DOTCIO (IT Services) | Submit a ticket to IT Services and support Center | | https://itssc.rpi.edu/hc/en-us | + +### Additional Academic Integrity Course Policy and Penalty Information + +Student-teacher relationships are built on trust. For example, students must trust that teachers have made appropriate decisions about the structure and content of the courses they teach, and teachers must trust that the assignments that students turn in are their own. Acts that violate this trust undermine the educational process. + +In this course, collaboration is expected and encouraged, as is the appropriate use of open source resources and code. All such uses should abide by the appropriate licensing and attribution requirements. Students should not represent other people's code as their own. + +The Rensselaer Handbook of Student Rights and Responsibilities and the Graduate Student Supplement (For 6000 level and above courses) define various forms of Academic Dishonesty and you should make yourself familiar with these. All assignments that are turned in for a grade must represent the student’s own work. In cases where help was received, or teamwork was allowed, a notation on the assignment should indicate your collaboration. Submission of any assignment that is in violation of this policy will result in (1) an academic (grade) penalty and (2) reporting to the Dean of Academic Affairs and either the Dean of Students (for Undergraduates) or the Dean of Graduate Education (for Graduate students). + +In this course, the academic penalty for a first offense is loss of a letter grade. A second offense will result in failure of the course. If you have any questions concerning this policy before submitting an assignment, please ask for clarification.