CONTRIBUTING.md

   1 Thank you for your contribution. OpenEMR (and global healthcare) continues to get better because of people like you!
   2
   3 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](https://open-emr.org/wiki/index.php/Development_Policies).
   4
   5 ## Code Contributions (local development)
   6
   7 You will need a "local" version of OpenEMR to make changes to the source code. The easiest way to do this is with [Docker](https://hub.docker.com/r/openemr/openemr/):
   8
   9 1. [Create your own fork of OpenEMR](https://github.com/openemr/openemr/fork) (you will need a GitHub account) and `git clone` it to your local machine.
  10     - It's best to also add an `upstream` origin to keep your local fork up to date. [Check out this guide](https://oneemptymind.wordpress.com/2018/07/11/keeping-a-fork-up-to-date/) for more info.
  11 2. `cd openemr` (the directory you cloned the code into)
  12     - If you haven't already, [install Docker](https://docs.docker.com/install/) for your system
  13 3. Run `docker-compose up` from your command line
  14     - When the build is done, you'll see the following message:
  15     ```sh
  16     openemr_1  | Love OpenEMR? You can now support the project via the open collective:
  17     openemr_1  |  > https://opencollective.com/openemr/donate
  18     openemr_1  |
  19     openemr_1  | Starting cron daemon!
  20     openemr_1  | Starting apache!
  21     ```
  22 4. Navigate to `http://localhost:8300/` to login as `admin`. Password is `pass`.
  23 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.
  24     - 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:
  25       ```sh
  26       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools build-themes'
  27       ```
  28 6. If you wish to connect to the sql database, this docker environment provides the following 2 options:
  29     - Navigate to `http://localhost:8310/` where you can login into phpMyAdmin.
  30     - Or you can directly connect to port 8320 via your favorite sql tool (Mysql Workbench etc.).
  31     - Use `username/user`: openemr, `password`: openemr .
  32 7. Developer tools and tricks.
  33     - To check PHP error logs:
  34       ```sh
  35       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools php-log'
  36       ```
  37     - To create a report of PSR12 code styling issues (this takes several minutes):
  38       ```sh
  39       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools psr12-report'
  40       ```
  41     - To fix PSR12 code styling issues (this takes several minutes):
  42       ```sh
  43       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools psr12-fix'
  44       ```
  45     - To check PHP parsing errors (this takes several minutes):
  46       ```sh
  47       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools php-parserror'
  48       ```
  49     - To run unit testing:
  50       ```sh
  51       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools unit-test'
  52       ```
  53     - To run api testing:
  54       ```sh
  55       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools api-test'
  56       ```
  57     - To run e2e testing:
  58       ```sh
  59       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools e2e-test'
  60       ```
  61     - To run services testing:
  62       ```sh
  63       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools services-test'
  64       ```
  65     - To run fixtures testing:
  66       ```sh
  67       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools fixtures-test'
  68       ```
  69     - To run validators testing:
  70       ```sh
  71       docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools validators-test'
  72       ```
  73 8. To run the entire dev tool suite (PHPCS fix, PHP parse error, unit/API/e2e/services/fixtures/validators tests) in one command, run
  74     ```sh
  75     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools clean-sweep'
  76     ```
  77 9. To run only all the automated tests (unit/API/e2e/services/fixtures/validators tests) in one command, run
  78     ```sh
  79     docker exec -i $(docker ps | grep _openemr | cut -f 1 -d " ") sh -c '/root/devtools clean-sweep-tests'
  80     ```
  81 10. When you're done, it's best to clean up after yourself with `docker-compose down -v`
  82     - 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.
  83 11. [Submit a PR](https://github.com/openemr/openemr/compare) from your fork into `openemr/openemr#master`!
  84
  85 We look forward to your contribution...
  86
  87 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](https://open-emr.org/wiki/index.php/OpenEMR_Installation_Guides#OpenEMR_Development_Versions) on the wiki.
  88
  89 ## Financial contributions
  90
  91 We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/openemr).
  92 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.
  93
  94 ## Credits
  95
  96 ### Contributors
  97
  98 Thank you to all the people who have already contributed to openemr!
  99 <a href="https://github.com/openemr/openemr/graphs/contributors"><img src="https://opencollective.com/openemr/contributors.svg?width=890" /></a>
 100
 101 ### Backers
 102
 103 Thank you to all our backers! [[Become a backer](https://opencollective.com/openemr#backer)]
 104
 105 <a href="https://opencollective.com/openemr#backers" target="_blank"><img src="https://opencollective.com/openemr/backers.svg?width=890"></a>
 106
 107 ### Sponsors
 108
 109 Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/openemr#sponsor))
 110
 111 <a href="https://opencollective.com/openemr/sponsor/0/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/0/avatar.svg"></a>
 112 <a href="https://opencollective.com/openemr/sponsor/1/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/1/avatar.svg"></a>
 113 <a href="https://opencollective.com/openemr/sponsor/2/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/2/avatar.svg"></a>
 114 <a href="https://opencollective.com/openemr/sponsor/3/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/3/avatar.svg"></a>
 115 <a href="https://opencollective.com/openemr/sponsor/4/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/4/avatar.svg"></a>
 116 <a href="https://opencollective.com/openemr/sponsor/5/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/5/avatar.svg"></a>
 117 <a href="https://opencollective.com/openemr/sponsor/6/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/6/avatar.svg"></a>
 118 <a href="https://opencollective.com/openemr/sponsor/7/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/7/avatar.svg"></a>
 119 <a href="https://opencollective.com/openemr/sponsor/8/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/8/avatar.svg"></a>
 120 <a href="https://opencollective.com/openemr/sponsor/9/website" target="_blank"><img src="https://opencollective.com/openemr/sponsor/9/avatar.svg"></a>