User Tools

Site Tools


systers_ghc_2015_osd_projects

Systers GHC 2015 OSD Projects

Our Systers has a long history with open source day at GHC and in fact, was instrumental in starting OSD at GHC in Atlanta GHC 2010. It is tradition that we participate in GHC OSD and this year is no exception. We will have several projects for our participants.

Skills Needed

No worries, we're here to help you get exposed to open source, technologies and a great community of women in computing. You can have NO programming experience to advance programming experience. We have something for everyone.

In fact, we need participants who want to help us define/design/code/etc …

  • user interface (also CSS and templates)
  • Database
  • Architects
  • Developers/Coders
  • Business Analysts
  • Functional Requirements
  • Testers/Quality Assurance
  • Configuration Managers (GitHub)
  • Documentation (user manuals and guides)
  • And everything else

Projects

To see a list of Systers projects we will be working on during GHC OSD, please visit our Systers GHC OSD GitHub page at the link below.

Systers GHC OSD Github page

OSD Development Process

As you are developing your code, we want you to do

  1. Coding
  2. Unit Testing
  3. Documentation

The following sections will help

1.1. Coding

Be sure you are documenting your code. Usual name, GitHub username, date is needed, but simple additional information is always useful. For example, if you defining a new function, what does function do, what are the parameters, what does it return? Another example, if you are using existing module from a framework, which one, and how you are referencing that module. Should not add too much time, but descriptive enough.

e.g.
####
# This is an example of commenting your code.
#
# Date: 14 October 2015
# Contributer: @github-username or email address or First name Initial last name (Rose R.).
#
# Description: This does what.
#
####

e.g. Online programming line #This is also a comment.

Each project has it's own VM that you can download and install. This prevents anyone stepping on anyone's code. Please read each project's README file on Systers GitHub Repo.

Systers repos » https://github.com/systers

1.2 GitHub

1.2.1 Be sure you're in Systers repo

Because we are working on Peace Corps projects, Systers manage development and code reviews before pushing to Peace Corps repo.

Systers repos » https://github.com/systers

You can review our code review process here » http://systers.org/systers-dev/doku.php/code_review_process

1.2.2 Create New Branch

For our new open source projects, we use GitHub for our code repository. Before checking in your work, please create a branch on your repository named “GHC15”. This will help admins later on to review your code and help in configuration management.

If you are new to GitHub, please consider the following tutorials. Don't worry, there will be folks who are familiar with GitHub that will be able to help you.

1.3 Design Documentation

Before you wrap up the day at GHC OSD, we would really appreciate it if you would document your work and check it in to each repo you worked on. We hope that you will want to continue the work you began at OSD, but we do understand this is not always the case. However, development must continue so documentation is always critical for other developers to jump right in particularly in open source environments.

Aspects your documentation should contain.
[1] Your approach to your design. (e.g. why you are using a certain package/module?)
[2] Touch points (If your application interacts with another application or framework, it's necessary to document these requirements. e.g. API specifications, etc.)
[3] Derived types and function, flags/error definition, database models

Keep it basic but informative. We understand the bulk of your work is in the coding, but Documentation is critical to maintain project momentum.

1.4 User Manuals/Guides

More information about open source software platform we will use for GHC OSD.

Systers OSD Schedule

Below is an tentative schedule and there is some flexibility with the times. The start and end times are strict however.

Time Activity
10:30am Begin with General announcements and presentations by orgs
1:00pm Systers announcements
1:10pm Ensure your environment is setup
1:20pm Q&A about your projects
1:30pm Coding
5:30pm Wrapup Coding and complete documentation
6:00pm General announcements wrap up
6:30pm End

OSD Assignments

After reviewing the projects above, please sign up for one of the projects you would like to work on during OSD on Wednesday. Then, definitely install your VM (for web projects only).

Name GitHub Username Project
Rose Robinson @rosariorobinson All projects

If you don't have a GitHub username account, don't worry, you can still work on our projects. If you do have a GitHub account, please add link to your GitHub page.

See you at GHC!

systers_ghc_2015_osd_projects.txt · Last modified: 2015/10/13 13:23 by rosariorobinson