CONTRIBUTING.md

Thank you for your contribution. OpenEMR (and global healthcare) continues to get better because of people like you!

The maintainers of OpenEMR want to get your pull request in as seamlessly as possible, so please ensure your code is consistent with our development policies.

Code Contributions (local development)

You will need a "local" version of OpenEMR to make changes to the source code. The easiest way to do this is with Docker:

1. Create your own fork of OpenEMR (you will need a GitHub account) and git clone it to your local machine.
   • It's best to also add an upstream origin to keep your local fork up to date. Check out this guide for more info.
2. cd openemr (the directory you cloned the code into)
   • If you haven't already, install Docker for your system
3. Run docker-compose up from your command line
   • When the build is done, you'll see the following message:

   openemr_1  | Love OpenEMR? You can now support the project via the open collective:
   openemr_1  |  > https://opencollective.com/openemr/donate
   openemr_1  |
   openemr_1  | Starting cron daemon!
   openemr_1  | Starting apache!

4. Navigate to http://localhost:8300/ to login as admin. Password is pass.
5. Make changes to any files on your local file system. Most changes will appear after a refresh of the page or iFrame you're working on.
   • An exception to this is if making changes to styling scripts in interface/themes/. In that case will need to clear web browser cache and run the following command to rebuild the theme files:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools build-themes'

6. If you wish to connect to the sql database, this docker environment provides the following 2 options:
   • Navigate to http://localhost:8310/ where you can login into phpMyAdmin.
   • Or you can directly connect to port 8320 via your favorite sql tool (Mysql Workbench etc.).
   • Use username/user: openemr, password: openemr .
7. Developer tools for php syntax checking, psr12 checking, and automated testing.
   • To check PHP error logs:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools php-log'

   • To create a report of PSR12 code styling issues (this takes several minutes):

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools psr12-report'

   • To fix PSR12 code styling issues (this takes several minutes):

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools psr12-fix'

   • To create a report of theme styling issues:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools lint-themes-report'

   • To fix theme styling issues:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools lint-themes-fix'

   • To check PHP parsing errors (this takes several minutes):

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools php-parserror'

   • To run unit testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools unit-test'

   • To run api testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools api-test'

   • To run e2e testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools e2e-test'

   • To run services testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools services-test'

   • To run fixtures testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools fixtures-test'

   • To run validators testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools validators-test'

   • To run controllers testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools controllers-test'

   • To run common testing:

     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools common-test'

8. To run the entire dev tool suite (PSR12 fix, lint themes fix, PHP parse error, unit/API/e2e/services/fixtures/validators/controllers/common tests) in one command, run

   docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools clean-sweep'

9. To run only all the automated tests (unit/API/e2e/services/fixtures/validators/controllers/common tests) in one command, run

   docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools clean-sweep-tests'

10. Developer tools to reset openemr and to load demo data.
    • To reset OpenEMR only (then can reinstall manually via setup.php in web browser):

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools dev-reset'

      • When running setup.php, need to use mysql for 'Server Host', root for 'Root Password', and % for 'User Hostname'.
    • To reset and reinstall OpenEMR:

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools dev-reset-install'

    • To reset and reinstall OpenEMR with demo data (this includes several users with access controls setup in addition to patient portal logins. See HERE for those credentials.):

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools dev-reset-install-demodata'

      • hint: this is also a great way to test any changes a developer has made to the sql upgrade stuff (ie. such as sql/5_0_2-to-6_0_0_upgrade.sql)
11. Developer tools to backup and restore OpenEMR data (database and data on drive) via snapshots.
    • Create a backup snapshot (using example below, but can use any alphanumeric identifier):

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools backup example'

    • Restore from a snapshot (using example below, but can use any alphanumeric identifier)

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools restore example'

    • To list the snapshots

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools list-snapshots'

12. Developer tools to send/receive snapshots (via capsules) that are created above in item 11.
    • Here is how to grab a capsule from the docker, which can then store or share with friends.
      • List the capsules:

        docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools list-capsules'

      • Copy the capsule from the docker to your current directory (using example.tgz below):

        docker cp $(docker ps | grep _openemr | cut -f 1 -d " "):/snapshots/example.tgz .

    • Here is how to send a capsule into the docker.
      • Copy the capsule from current directory into the docker (using example.tgz below):

        docker cp example.tgz $(docker ps | grep _openemr | cut -f 1 -d " "):/snapshots/

      • Restore from the new shiny snapshot (using example below):

        docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools restore example'

      • Ensure run upgrade to ensure will work with current version OpenEMR:

        docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools upgrade 5.0.2'

13. Developer tools to turn on and turn off support for multisite feature.
    • Turn on support for multisite:

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools enable-multisite'

    • Turn off support for multisite:

      docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools disable-multisite'

14. Xdebug and profiling is also supported for PHPStorm.
    • Firefox install xdebug helper add on (configure for PHPSTORM)
    • PHPStorm Settings->Language & Frameworks->PHP->Debug
      • Start listening
      • Untoggle "Break at first line in PHP scripts"
      • Untoggle both settings that start with "Force Break at first line..."
    • Make sure port 9000 is open on your host operating system
    • Profiling output can be found in /tmp directory in the docker
15. When you're done, it's best to clean up after yourself with docker-compose down -v
    • If you don't want to build from scratch every time, just use docker-compose down so your next docker-compose up will use the cached volumes.
16. Submit a PR from your fork into openemr/openemr#master!

We look forward to your contribution...

If you do not want to use Docker, you can always install OpenEMR directly on your local environment. This will require installing additional dependencies for your operating system. For more info see OpenEMR Development Versions on the wiki.

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to openemr!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)