GCI 2014: Plans, proposals, and open invite to join in!

Joel Sherill who is advising us for GCI has a script - https://github.com/joelsherrill/gci_tasks which is can read a CSV and add it to melange. Our GCI JIRA becomes the template for One-Per-Student and Multiple-Per-Student tasks that needs to be duplicated in the melange task list. We will use one the scripts to do that once we are selected as an organization in GCI – Saptarshi and Suranga

@sunbiz, I created https://issues.openmrs.org/browse/GCI-6 and https://issues.openmrs.org/browse/GCI-5 for students to add .gitignore files to OpenMRS modules. I was feeling very happy about these, because they were nice and easy coding tasks for students.

And then I noticed that quite a number of modules can benefit from this. For example,

Add .gitignore file:

Add OpenMRS License file:

delete mavenize log:

Add read me files:

So, I’d recomend one ticket for fixing ALL readme’s, another for fixing ALL licenses, etc. What do you think ?

1 Like

Not at all. I would be more than happy to mentor new students for OpenMRS. But I’ve been away from the whole OpenMRS point of view for some months now. I have to start looking where the actual requirement is of where it might be useful. I will start looking at things that might be useful and post my comments here. Thank you for “Recruiting” me. :smile:

Okay… Right of the bat there are two things that I think would be pretty useful for the students to get to know about openmrs and get some work done that I guess is mostly neglected by developers(Including myself).

  1. Having message.properties for every module and checking if pages in them have display text that is not in message.properties.
  2. Labeling the documentation of our wiki. We have a great wiki but sifting through it can be painful sometimes. The labels for documentation have been rarely used and have been mostly used only for the main page of the module. Maybe we can create tasks like every module’s wiki page gets labelled by that module name for starters then move on to labeling if that particular document is a technical documentation/ How to documentation and so on. I know it might turn out to be a problem if not labeled properly but I’m hoping for the best :smile:
2 Likes

Quick comment:

I think @maurya’s suggestion on moving text to messages.properties is a very good idea, especily in terms of GCI scope. What we could do is identify a list of modules that are not that frequently used, and ask students to pick one, review the code, and move any free-text into the messages.properties file. Each student will be able to complete this ticket only once.

I think this is a great idea because,

  1. Its a very realistic task
  2. It gives students a chance to explore our modules and source code
  3. It lets them get familiar with how to use github + our dev conventions

—[update] ----

@maurya, I created a ticket for this task here. Do you have any modules that you’d want us to review ? if so, please add the links to their github repos in https://issues.openmrs.org/browse/GCI-7

2 Likes

@surangak I think the code formatting and correcting bad code segments which identified in sonar or findbugs can be listed as a very good task for student to learn about how to write good codes. Since we already have Sonar setup in [1], There are number of places which we can correct. For example [2] shows bad coding practice. We can isolate feasible task for a student. So with the guidance he can identified how correctly to fix them. [1] - https://ci.openmrs.org/sonar [2] - https://ci.openmrs.org/sonar/drilldown/issues/1865?&rule=squid%3AS1148&rule_sev=CRITICAL&severity=CRITICAL#

Shall we have a tasks for code formatting and correct bad code segments which shows in Sonar.

Also we can have some real world user story with OpenMRS 2.x. Where we can mentor a student to create a screen-cast about using OpenMRS 2.x. Suppose hospital needs to have a EMR to manage hopital activities. We can have a screen-cast on how OpenMRS 2.x will best suits for it. In screen-cast we can include, how patient will go through the set of stages to enter to word. First patient will registered, then he will moved to inpatient word where doctor will first check the patient and flow through the patient flow. Having this screencast, new implementer will have clear idea about how to use system with applications. I believe this is not a hard task where student only needs to understand the use of OpenMRS. We can use demo site obviously.

@harsha89, I think the code formatting is a good idea. The rules for formatting XML and non-Java files is missing from the formatter.xml maven plugin and would like to see some GCI students come together and create rules for formatting those files. Can you please create issues corresponding to this in the JIRA GCI project?

@sunbiz sure I will create tasks for them :slight_smile:

We have a Monday deadline for the GCI application. So a quick burst of JIRA tickets will go a long way. We can improve on those in the next few weeks. But getting all the task types strawman will be a good thing :slight_smile:

@sunbiz Noted will do by today. :slight_smile:

@surangak I’ve updated a list of modules even if they had one or two pages with free text.

What do you guys think about updating the Readme.md files of all our modules to contain the module’s wiki links as a task like

Module’s

Wiki link: Installation guide/user guide: Technical documentation: unresolved issues search link:

Might be useful for new developers who start working on a module.

If you guys agree I will create a ticket for it. But i’m confused if it comes under code or documentation as it needs github pull requests.

@maurya, I think its a good idea. Please create a ticket with task with all of those required to be completed for a single module. I think it should come under documentation, even though has a pull request. It also seems like a repeatable task, since one student can take up different modules and do these

Never mind, I see that @surangak created a ticket for updating readme files, right when I was writing that post. @surangak is there a set template for our readme files?

@sunbiz I will update @surangak’s ticket to have these details and also include more github links to the modules that can be updated.

Promo video would be a really cool Task. eg: :smiley:

https://www.youtube.com/watch?v=zseSTmq1XDM

3 Likes

Hi @surangak, nice indeed to hear that openmrs is now participating in this, am available and willing to participate as a mentor and so feel free to add me to the mentor’s list ::smile:

Please keep me updated with details on this.

2 Likes

I’ll work on putting them up by the end of the week. That said, if @hannah could verify she doesn’t have any changes to them she still wants to make, that’d be great :smile:

1 Like