Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 10.5 KB

C.contribution_to_oss.md

File metadata and controls

74 lines (49 loc) · 10.5 KB
Raw

Contribution to an Open Source Software Project

GROUP ASSIGNMENT

Deadline: MULTIPLE (KEEP YOUR EYES OPEN)

You are requested to make a significant contribution to an Open Source Software project. You will need to interact with the community and the existing code base. You MUST make a code contribution. You may start with a small contribution on documentation or translation to learn the process (although, this is not required).

The first step towards that end is choosing a project. There are a couple of them that I anticipate that can accomodate some of you (a few more to come):

  • animint2 is an R package for making interactive animated data visualizations on the web, using ggplot syntax and two new keywords:

    • showSelected=variable means that only the subset of the data that corresponds to the selected value of variable will be shown.
    • clickSelects=variable means that clicking a plot element will change the currently selected value of variable. Prof Toby Hocking is the main contact point for this project. More information here: https://github.com/rstats-gsoc/gsoc2023/wiki/Animated-interactive-ggplots
    • Skills: Requires R + JavaScript coding skills

  • DeepState - has multiple help wanted issues, some of which might be quite suitable for an advanced undergrad. It's a test generation tool for C and C++, GoogleTest that allows automatic test generation, basically. Bringing security vulnerability detection tools into the unit testing/early dev cycle is the big idea. Prof. Alex Groce can provide more info/help if students are interested. DeepState is a fairly widely used open source testing tool, and Dr. Groce is probably the main active developer now

  • FluxPuppy - NAU developed Android (Java) software to work with Licor 820 and 840 CO2 measurement devices. The software will be of great interests to the ecology community. --> The tasks will be available on demand, some ideas:

    • A big up here would he
    • The current software bogs down when there are very many files in the storage system. Any navigation between screens (e.g. open file directory) it will go black for perhaps 60s. Saving leads to the same effect.
    • It is difficult to get files off the tablet, amplifying the first issue. I have only been able to make the email option work, and there is an unknown maximum amount of files which can be attached, leading to having to "batch send" files. A wired option compatible with multiple operating systems would be very convenient. Again, perhaps I am inept.
    • The voltage seems to be unreliable where I will get voltage warnings that do not match what I measure with a multimeter. E.g. I get a low battery warning 10.5 V, I measure 11.5 V.
    • The app consumes a lot of energy and then the tablet is nearly impossible to recharge in the field. An auto screen-dimming feature might be useful. I have no idea what this looks like, just an idea.
    • Newest gas analyzer has a built in pump, and would be good for Flux Puppy to be modified to control the pump
    • Opening issues explaining the tasks here and creating an appropriate contributing.md file would be a great improvement here as well!
    • Skills: Java mobile + UI

  • actR The goal of actR – the Abrupt Change Toolkit in R – is to streamline abrupt change detection, significance testing, uncertainty quantification and visualization for paleogeoscientific datasets. This project is funded by the Belmont Forum as part of the "Abrupt Changes in Climate and Ecosystems - Data & e-Infrastructure (ACCEDE)" project, as part of the Science-driven e-Infrastructure Innovation program. The project is maintained at NAU by Dr. Nicholas P. McKay.

    • Skills: R

  • codappurpleairplugin: The project analyses data from the publicly available air population sensors in the US obtained via purple air API and integrates them in the Common Online Data Analysis Platform (CODAP). This project is a collaboration betwenn Dr. Ashish Amresh and Dr. Vipin Verma (ASU) -- vverma9@asu.edu

    • What to expect: Small new features
    • Skills: Plain HTML, Javascript, REST APIs

  • LTC-LMS. It is a canvas/blackboard like web-interface designed to facilitate teaching. This project is a collaboration betwenn Dr. Ashish Amresh and Dr. Vipin Verma (ASU) -- vverma9@asu.edu

    • What to expect: Bug fixes, Small new features, Refactoring/improving the maintainability
    • Skills: MEAN Stack, CentOS deployment

  • VectorUnknown3D A game made in Unity to teach linear vector algebra. This project is a collaboration betwenn Dr. Ashish Amresh and Dr. Vipin Verma (ASU) -- vverma9@asu.edu

    • What to expect: Bug fixes, Small new features, Refactoring/improving the maintainability

    • Skills: Unity3D, C#

  • Jabref - Citation Manager. Mainly developed in Java. JabRef people are enthusiastic about applying MVVM to their project. It is a good learning experience, and will certainly help the community. Use the wiki as a starting point for development. In addition there is an example on the JavaFX stuff regarding the MVVM pattern. Here [https://github.com/JabRef/jabref/wiki/Code---JavaFX].

    • Skills: Requires mostly Java know-how (JavaFX is a plus)

  • openMTPK - General Purpose Mathematics Package. Development library written in C++ with binding for Python aims to implement an array of mathematical topics into modular, reusable, and effecient functions (Calculus, LinAlg, Number Theory, Stats/ML & more). See the TODO list & the contribution guideline for help on getting started. This package is in the early stages of development and new ideas are heavily encouraged.

    • Skills: C++

At the end of the term, it is expected that you have one or more contributions submitted, peer-evaluated (in classroom), submmited (and hopefully reviewed by project members, and accepted). Here are overall steps and dates (more details to come).

EVERYTHING PRODUCED DURING THE COURSE NEED TO BE PEER-REVIEWED BY ANOTHER GROUP BEFORE THE FINAL SUBMISSION

Step Expected deliverable Deadline
Checkpoint 0 The decision about project and plan on steps toward contribution.
What to deliver: Document (simple and short) justifying the choice, based on technical and community aspects of the project, and how it fits the group.
How to deliver: BBLearn C0 - Checkpoint 0 document		 March 21
Checkpoint 1 1. Presentation: with (i) Task(s) details + progress report; (ii) First impressions about the project and guidelines availability
How to deliver: BBLearn C1 - Checkpoint 1 (submit the presentation and the document)		 March 28
Checkpoint 2 Group presentation in class (Instructor + group). I will chat with the groups to see how things are going
What to deliver: Informal Progress report (document), including code review performed by another group (This task may be done at some point BEFORE the deadline. If you are having trouble finding someone to review your code, let me know.
How to deliver: BBLearn C2 - Checkpoint 2 (Only an informal report mentioning what tasks were accomplished and how did the code review go)		 April 18
Contribution to Open Source (Final report) 1. Document: Summary of the contribution process (I recommend writing on-the-fly to avoid forgetting things). I want you to report the process from deciding the project until the last activity, mentioning the pros, cons, lessons learned, and how each step helped you/your group. It can be a diary-based report, in which you mention how things evolved weekly (for example); or it can be an activity-based report, in which each section is about one step of the process.
Group + instructor presentation Can be done in class or scheduling to meet in my office. It must happen BEFORE OR ON May 2nd, and as early as you are ready to deliver the report (I will provide a spreasheet so you can schedule your presentation)		 May 2

IN CASE THE PROJECT IS HOSTED ON GITHUB: The group will need to curate a fork of the project in which they will work. All commits need to become a Pull-request in this fork to train the students on the git use and also in the GitHub use. To do so, it is recommended that you create a central fork, and each student in the group create a "sub-fork". Whenever there is a pull request ready for reviewing, the instructor (me) will assign another group to proceed with the peer review (giving them a specific deadline to do so -- be prepared to do it within the week). After receiving the OK from the peer-reviewing group, you can go ahead and create a pull request against the other project.

IN CASE THE PROJECT IS HOSTED OUTSIDE GITHUB: The group will need to curate a clone of the project in which they will work. Whenever there is a patch ready for reviewing, the instructor (me) will assign another group to proceed with the peer review (giving them a specific deadline to do so -- be prepared to do it within the week). After receiving the OK from the peer-reviewing group, you can go ahead and submit it the way the project wants it.

Final Report

Each group will write up a document describing the contribution process of an existing open source project, based on investigating the publicly available information about this project. This is the final deliverable of the project and can contain problems faced during the process, how did you apply your knowledge,and what kind of new skills the group acquired during this journey. It needs to present and overview of the project and the task, followed by the details of your contribution process.