# Contribution Guide If you have any comment or advice, please report your [issue](https://github.com/bubkoo/html-to-image/issues), or make any change as you wish and submit a [PR](https://github.com/bubkoo/html-to-image/pulls). ## Reporting New Issues - Please specify what kind of issue it is. - Before you report an issue, please search for related issues. Make sure you are not going to open a duplicate issue. - Explain your purpose clearly in labels, title, or content. We will confirm the purpose of the issue, replace more accurate labels for it, identify related milestone, and assign developers working on it. ## Submitting Code ### Pull Request Guide 1. [Fork][fork] and clone the repository 2. Configure and install the dependencies `pnpm` 3. Make sure the tests pass on your machine `pnpm test`, note: these tests also run the TypeScript compiler (`tsc`) to check for type errors, so there's no need to run these commands separately. 4. Create a new branch `git checkout -b my-branch-name` for development. The name of branch should be semantic, avoiding words like 'update' or 'tmp'. We suggest to use `'feature/xxx'`, if the modification is about to implement a new feature. 5. Run the test `pnpm test` after you finish your modification. Add new test cases or change old ones if you feel necessary. 6. Push to your fork and [submit a pull request][pr] 7. Pat your self on the back and wait for your pull request to be reviewed and merged. No one can guarantee how much will be remembered about certain PR after some time. To make sure we can easily recap what happened previously, please provide the following information in your PR. 1. Need: What function you want to achieve (Generally, please point out which issue is related). 2. Updating Reason: Different with issue. Briefly describe your reason and logic about why you need to make such modification. 3. Related Testing: Briefly describe what part of testing is relevant to your modification. 4. User Tips: Notice for html-to-image users. You can skip this part, if the PR is not about update in API or potential compatibility problem. ### Style Guide tslint can help to identify styling issues that may exist in your code. Your code is required to pass the test from tslint. Run the test locally by `$ pnpm lint`. ### Commit Message Format You are encouraged to use [angular commit-message-format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format) to write commit message. In this way, we could have a more trackable history and an automatically generated changelog. ```xml ():