All OpenMRS ID accounts have been reset.

Read more and change your password before signing in.
Icon

EXTENDED: OMRS14 Proposals due 30 April! Read more and submit a proposal at OpenMRS Talk.

Skip to end of metadata
Go to start of metadata

 

Your first step when getting started as a developer should be to look through our New Developer's Guide. (Download a pdf here: http://go.openmrs.org/newdev-pdf.) This book will give you all the information you need to get started as an OpenMRS developer in an easy to read and concise format. 
Once you've read through the book, here's a quick summary of things you can do to get started!

  1. If you don't have one, create an OpenMRS ID, which you can use to contribute to this Wiki, manage issues in JIRA, and more.
  2. Sign up for the developer (and maybe implementer) mailing lists. The developers mailing list is a great place to ask specific questions if you get stuck along the way (if you can't find answers elsewhere).
  3. Create an account at https://github.com/
  4. Configure your Eclipse environment with the Step-by-Step Installation for Developers. The New Developer's Guide has a helpful chapter on Setting Up Your Development Environment.
  5. Watch some OpenMRS development screen-casts on YouTube.
  6. Create your first OpenMRS module. The New Developer's Guide features a chapter on how to create a Hello World Module.
  7. Find some introductory issues (also shown below) that have the "Ready for Work" status to work on, and assign them to yourself by clicking the Claim Issue button. (Ask for clarification on the issue if needed.) If you find yourself taking long (days) without making any progress, feel free to un-assign yourself from the issue and choose another.
  8. Try as much as you can to include unit tests for your changes. Remember to also do an "mvn clean install" to ensure that all existing unit tests and yours pass. Then create a pull request. If your changes affect the user interface, please run the web application to see the effects, and then attach a screenshot, before you commit.
  9. Log your time spent on that issue and click "Request Code Review" and a core developer will get you some feedback in short order
  10. Find another issue or choose a larger project to work on. See Unassigned Projects.
  11. If you join a sprint or choose to share your module (we hope you do), then you'll want to read about Using Git.
  12. When you no longer want to work on an issue that you have already assigned to yourself, please remember to un-assign yourself from it such that others can take it up. If you have any findings that you feel would be useful to whoever takes it up, please feel free to add a comment.

 

Icon

 

 

 

New Developers

Please record your experiences (good or bad) on this child page.  We are always trying to find ways to improve where we can do better and reinforce things we are doing well, so getting input from your perspective is very helpful & appreciated.

Current Sprint Issues

At all times, we have an ongoing Development Sprint.

For each sprint, we include issues of low complexity which are suitable for developers who are getting started with OpenMRS. We therefore encourage you to look in this pool of issues when looking for which to work on. Because a sprint has a number of developers working on a set of related features at the same time, working on it will give you the advantage of getting more immediate feedback in terms of responses to blocker questions, reviewing of your code, mentoring and guidance regarding how to do the issues, pair programming where necessary, and more.

You can always look at the Sprint Schedule to check for the active or current development sprint. In case of any questions about these sprints, feel free to ask on IRC or the developers mailing list.

Introductory Issues

The following issues are both "introductory" and also "curated", meaning that they have thorough descriptions of how to approach solving them:

Loading
Showing 20 out of 22 issues Refresh

If you aren't able to find an appropriate issue in the list above, here is the complete list of "introductory" issues, not necessarily "curated":

Loading
Showing 20 out of 57 issues Refresh

After Introductory Issues

After doing a couple of introductory issues, you may feel like working on issues of increased complexity. Or you may find the introductory issues boring and hence want to work on something more exciting.

Should you find yourself in this state, the active Development Sprint may be a good place for you to look next. The sprint has issues for all levels of complexity. The Sprint Schedule will always be updated with the active or current development sprint.

You could also do code reviews for pull requests.

If you try out the sprint, code reviews, and still find it boring, please feel free to ask us on IRC or the developers mailing list.

Other Useful Resources

Code Style

Coding Conventions

Newbie Guide to OpenMRS Development - by Sri Maurya Kummamuru

  • No labels

4 Comments

  1. It would actually be good to have the green message directing them to the current sprint

     

    1. I fully agree with Wyclif. What do others think?

      1. How about both – i.e., refactor the tip to direct people to the current sprint or, if they don't have luck there, then to the community development swim lane?