Students, Projects, & Mentors
10 Steps for Accepted Students
Please read the acceptance e-mail for specific tasks accepted students should do right away. Generally, after accepted interns are announced, here's what should happen:
- Sign into your OpenMRS.org email account. Details are in your acceptance email.
- Introduce yourself on the GSoC 2015 student introduction page on OpenMRS Talk.
- Set up a blog for your work on open source projects, including GSoC. Post the URL on OpenMRS Talk. If you don't have a blog yet, you should create one. You will be required to write a blog post every week about your planning work and project progress during GSoC.
- Contact your mentor immediately. Make a plan to communicate with them regularly - at minimum, once each week. Determine the best way to communicate (e-mail, IRC, IM, VoIP, telephone, etc.). Agree on final requirements with your mentor, and post a formal written proposal including project schedule (timeline) on which you both agree.
- Begin attending the weekly Developers Forum to briefly introduce yourself and meet other interns & contributors. Attend as many Developers Forums as your schedule permits.
- Spend lots of time in our IRC channel and on OpenMRS Talk with other community members & interns.
- If relevant, make sure you have OpenMRS installed and running. (You should have done this already since you were accepted.) Read Developer Guide, Getting Started as a Developer, and ask others in the community if you have questions. If you ask questions the smart way, you'll get better responses.
- Make sure your development environment is installed and running, and optimized for maximum efficiency. Review our Conventions page.
- Review any JIRA issues related to your project and work on some initial bugs or feature development, or work on some general OpenMRS bugs. Ask your mentor for guidance. (This doesn't mean begin your project!)
- Browse the current OpenMRS code specific to your project and review the requirements for your project together with your mentor.
Expectations of Students & Mentors
What we expect of students:
- Become familiar with OpenMRS and your project before the start date.
- Complete a short required "progress report" each week so we can make sure things are on track and there are no problems with your project.
- Write at least one blog post every week to help stay on schedule and to share your work publicly.
- Commit early. Commit often. This is an important value in our open source community - read why.
- Prepare a mid-term and final project presentation video about your project's status, progress, and any questions you have for the community.
- You are now part of our developer community. We want you to feel like part of the team, so we hope you will:
What students should expect of OpenMRS during the summer:
- You will have fun!
- You will learn how to work within an open source project – one that's helping people save lives around the world.
- You will have dedicated time (4-5 hours each week) with an experienced OpenMRS mentor, and will have a backup mentor for questions or problems.
- If you ask a question the smart way, our community will do its best to help you.
- The Summer of Code program leaders (both at OpenMRS and Google) will be available if any problems arise between students and mentors.
What we expect of mentors:
- Help your student be successful. Commit to spending a minimum of 4-5 hours each week with your student answering questions, giving advice, working together, and evaluating his or her progress.
- Complete a short "progress report" each week to help stay on schedule and catch potential problems early.
- Read the GSoC Mentoring Manual and ask questions if you have them.
- Reach out to the Summer of Code project leaders if you have questions or concerns.
- Have fun and work hard! The highest-performing mentors will get an expenses-paid trip to Google's headquarters in October to geek out with fellow mentors from other open source projects.
Helpful OpenMRS Community Resources
- Join OpenMRS Talk and sign in regularly to keep track of activities in the OpenMRS Community.
- If possible, join the Developers Forum every Thursday. You can participate by telephone, VoIP, or even just on IRC.
- We use JIRA as a tool for issue tracking and project management.
- Tips for using e-mail:
- If you have a highly specific question, contact your mentor.
- Technical discussions, ideas, and requests for feedback should be sent to the entire community on the developers mailing list.
- IRC discussions in the #OpenMRS channel of Freenode are always fun! Useful for shorter discussions or for large group discussions.
- Use the OpenMRS wiki often:
- Be sure to make a user profile page.
- Every project should have a OpenMRS wiki page where you document your project, progress, technical details, show mock ups, etc.
- Google Docs — an excellent tool for sharing and collaborating in real time on documents or spreadsheets, when the wiki is not appropriate.
- Scheduling tools:
Our Technology At-A-Glance
The OpenMRS project is architecture is quite extensive, and incorporates a number of different components, programming languages and frameworks. As an GSoC student, you may be required to work on one or many of these components. Each project is different – consult the mentor and project documentation for details. The OpenMRS Developers Guide covers some of our software's technical architecture in more detail.
Some of the core skills you might be able to use in our projects this year include:
- The Spring Framework
- The Hibernate Framework
- More to come ....
9 Steps Toward Becoming a Successful Applicant
We're happy you were interested in working with OpenMRS during Summer of Code 2015. Here are some tips that we prepared to help your application process be easier and more successful. These are all things you should have begun early to start getting involved.
Get started as a developer in our community right away. The sooner you do this, the more familiar we'll be with your name and with your work.
Specifically, the 9 steps to do:
- First, read the GSoC Student Guide to get familiar with Google Summer of Code.
- Create an OpenMRS ID and a personal space on your wiki and tell us about yourself. Here's a great personal wiki page from a MediaWiki student you might want to use as a guide.
- Sign in to OpenMRS Talk and introduce yourself to the community in the "Welcome - please introduce yourself!" topic. Check out the GSoC category there for questions and updates.
- Join our developers mailing list to keep track of what's going on in our development community. To help control the volume of email our developers received, do not introduce yourself or ask questions about a GSoC project on this mailing list without first contacting its mentor (listed here) directly.
- Join our IRC channel and introduce yourself – meet some other community members and tell us about yourself and why OpenMRS is interesting to you. Spend lots of time in IRC getting to know us.
- To start, install OpenMRS (just like a user would) and learn a bit about how it works. If you have problems, write to the developers mailing list and we'll help you work through them.
- Set up your development environment and fix some simple bugs listed on our Introductory Tickets list. Read Getting Started as a Developer for details on how to do this. This demonstrates that you are self-motivated, makes you familiar to the developer team, and gives you a taste of the development process. Keep track of the issue numbers that you work on. We'll ask you for them in your application.
- Join our Developers Forum every Thursday to learn about the latest activities & work happening in our community or join an OpenMRS University call every Wednesday. You can participate by telephone or using your web browser.
- Interact with our community. Continue to ask smart questions (what?) on our mailing list or hang out on IRC to ask and answer questions.
When preparing your application, also remember to:
- Use the title of the project idea for which you are applying as the title of your application. If you are submitting an application to work on the "Add whirlygigs to OpenMRS" project, then make the title of your application "Add whirlygigs to OpenMRS".
- Submit a thoughtful application. Simply regurgitating documentation from the wiki will not impress us. Rather, show that you've thought about the project and provide some ideas on how you would approach the solution. You can ask other people in the community for ideas in advance. The best applications not only refer to one of the GSoC projects, but also demonstrate you have thought about the project by providing a description of how you think you might approach the project, including a rough timeline of the steps involved.
Application Requirements & Questions
You should have communicated in advance with the potential mentors listed above to prepare one or more project proposals. This proposal must describe in detail how you would plan to approach the project, and must include goals and a draft timeline. In addition to the project proposal, you needed to respond to the following questions:
- Who are you? What are you studying?
- Why are you the right person for this task?
- Describe in detail your software development experience by various technologies. Include all technologies you have used for development projects.
- List any previous experience working with open source projects other than OpenMRS. (This experience is not a requirement.)
- Provide links to any websites or applications created by you, or other source code examples.
- Please provide the URL to your wiki personal space. (If you don't have one yet, please create one.)
- You must have made at least one coding contribution to OpenMRS BEFORE submitting your proposal. Please include in your proposal all relevant issue numbers, pull requests, commit links, etc. for these contributions. If you don't include this information, your proposal will not be reviewed. It's not necessary for your pull requests need to be merged. We just want to see that you've made some effort to learn the basics about OpenMRS.
- Describe your interactions with our community so far. Include dates of developer forums you have attended, and include any IRC nicknames used when visiting our channel previously.
- What is your preferred method of contact and how should we reach you with it? (phone, email, IRC, IM, etc.)
- Do you have any other commitments during the program? (Include any and all holidays, vacations, travel, exams, classes, research projects, other work, job offers, etc.)
Have Additional Questions?
- If you are interested in Summer of Code this year and have further questions that aren't answered here, please post them in our GSoC category at OpenMRS Talk.