1*fb347f35SAndreas GohrContributing 2*fb347f35SAndreas Gohr============ 3*fb347f35SAndreas Gohr 4*fb347f35SAndreas GohrIssue tracker 5*fb347f35SAndreas Gohr------------- 6*fb347f35SAndreas Gohr 7*fb347f35SAndreas GohrThe Issue tracker serves mainly as a place to report bugs and request new features. 8*fb347f35SAndreas GohrPlease do not abuse it as a general questions or troubleshooting location. 9*fb347f35SAndreas Gohr 10*fb347f35SAndreas GohrGeneral troubleshooting 11*fb347f35SAndreas Gohr------------- 12*fb347f35SAndreas Gohr 13*fb347f35SAndreas GohrFor these questions please use [Discussions](https://github.com/mpdf/mpdf/discussions). Add your enquiry 14*fb347f35SAndreas Gohrto appropriate category and as always, include a reproducible code example when applicable (see code example guidelines below). 15*fb347f35SAndreas Gohr 16*fb347f35SAndreas GohrYou can also use the [mpdf tag](https://stackoverflow.com/questions/tagged/mpdf) 17*fb347f35SAndreas Gohrat [Stack Overflow](https://stackoverflow.com/) 18*fb347f35SAndreas Gohras the StackOverflow user base is more likely to answer you in a timely manner. 19*fb347f35SAndreas GohrWhen doing so, make sure you comply to StackOverflow question guidelines. 20*fb347f35SAndreas Gohr 21*fb347f35SAndreas GohrBug reports 22*fb347f35SAndreas Gohr------------- 23*fb347f35SAndreas Gohr 24*fb347f35SAndreas Gohr* Bug reports **MUST** contain a small example in php/html that reproduces the bug. 25*fb347f35SAndreas Gohr* The code example **MUST** be reproducible by copy&paste assuming composer dependencies are installed. That means: 26*fb347f35SAndreas Gohr * No calling unrelated funcions, 27*fb347f35SAndreas Gohr * an actual final HTML code has to be present, pasting a template file is not enough, 28*fb347f35SAndreas Gohr * if the bug considers import or fonts, example source PDF/TTF/etc files have to be included. 29*fb347f35SAndreas Gohr* Failing to provide necessary information or not using the issue template will cause the issue to be closed until required information is provided. 30*fb347f35SAndreas Gohr* Please report one feature or one bug per issue. 31*fb347f35SAndreas Gohr 32*fb347f35SAndreas GohrFeature requests 33*fb347f35SAndreas Gohr------------- 34*fb347f35SAndreas Gohr 35*fb347f35SAndreas GohrFeature requests have to be labeled as such and have to include reasoning for the change in question. 36*fb347f35SAndreas Gohr 37*fb347f35SAndreas Gohr 38*fb347f35SAndreas GohrPull requests 39*fb347f35SAndreas Gohr------------- 40*fb347f35SAndreas Gohr 41*fb347f35SAndreas GohrPull requests should be always based on the default [development](https://github.com/mpdf/mpdf/tree/development) 42*fb347f35SAndreas Gohrbranch except for backports to older versions. 43*fb347f35SAndreas Gohr 44*fb347f35SAndreas GohrGuidelines: 45*fb347f35SAndreas Gohr 46*fb347f35SAndreas Gohr* Use an aptly named feature branch for the Pull request. 47*fb347f35SAndreas Gohr* Only files and lines affecting the scope of the Pull request must be affected. 48*fb347f35SAndreas Gohr* Make small, *atomic* commits that keep the smallest possible related code changes together. 49*fb347f35SAndreas Gohr* Code must be accompanied by a unit test testing expected behaviour whenever possible. 50*fb347f35SAndreas Gohr* To be incorporated, the PR should contain a change in the CHANGELOG.md file describing itself 51*fb347f35SAndreas Gohr 52*fb347f35SAndreas GohrWhen updating a PR, do not create a new one, just `git push --force` to your former feature branch, the PR will 53*fb347f35SAndreas Gohrupdate itself. 54