Welcome to the world of OpenMRS development! This page introduces you to the things you'll need to get started on your journey.
- Create an OpenMRS ID. Your OpenMRS ID defines your username in the OpenMRS community and provides access to community resources, like this wiki, our issues tracker, and the OpenMRS Talk forums.
- Create a new case at OpenMRS Helpdesk stating you'd like to contribute and would like edit access to Wiki and JIRA. Because of spammers, we must require this extra step before you can edit wiki pages or make any changes to JIRA tickets.
- Create a GitHub account if you don't have one.
- Join discussions at OpenMRS Talk. Be sure to add your GitHub username to your settings in Talk, then introduce yourself to the community. You can learn more about how to use Talk by reading this introduction and FAQ.
- Set up your development environment. Follow the Step-by-Step Installation for Developers and How-To Setup And Use Your IDE. The Developer's Manual also has a helpful chapter on Setting Up Your Development Environment.
- Download and install the OpenMRS SDK.
- Watch some OpenMRS development screencasts on YouTube.
- Create your first OpenMRS module. The Developer's Manual features a chapter on how to create a Hello World Module.
- Claim an Issue. Review community priorities and introductory issues below to find an issue of interest to you that is ready for work, claim it, and make your first contribution. If you need any clarification on the issue, use OpenMRS Talk or join IRC for real-time interaction. If you find yourself taking long (days) without making any progress, feel free to un-assign yourself from the issue and choose another.
- Meet some other developers through real-time chat in Telegram (telegram.me/openmrs) or IRC (irc.openmrs.org).
- Learn about OpenMRS Developer Stages, earn the /dev/null badge and, when you're ready, take the quiz to earn /dev/1.
- 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. Remember to have a look at the Pull Request Tips.
- When you complete work on an issue, log your time spent on that issue and click "Request Code Review" and another developer will get you some feedback in short order.
- Read about Using Git. This is especially useful if you join a sprint or choose to share your module (we hope you do).
- Avoid staying assigned to issues you aren't actively working on. 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.
- Do some code reviews. Here is the list of pull requests that are waiting for review. Reviewing other people's work is one of the great ways of learning about OpenMRS. You can even review code for some one more experienced than you. Reviews can be as simple as checking to ensure that commits are squashed into one, adherence to our code conventions, finding spelling mistakes, or pointing out missing JavaDoc comments. More details about code reviews can be found at this wiki page.
- Review Unassigned Projects if you want to find a larger project to work on.
Share your experience
New developers, please share your experiences (good or bad) on this 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.
Here is a list of tickets prioritized by the community from the Community Priority Kanban:
The following issues are both "introductory" and also "curated", meaning that they have thorough descriptions of how to approach solving them:
If you aren't able to find an appropriate issue in the list above, you can take a look at the complete list of "introductory" issues, (not necessarily "curated").
Beyond Introductory Issues
You could also do code reviews for pull requests.
Current Sprint Issues
Other Useful Resources
- Code Review
- Code Review Checklist
- Simple Secure Coding Checklist
- Newbie Guide to OpenMRS Development - by Sri Maurya Kummamuru