Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 921 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (16 loc) · 921 Bytes
Raw

Contributing to PDFTron - React Native

Issues

  1. Check existing issues (open/closed) to avoid duplicates.
  2. Be clear about what the problem is.
  3. Make sure to paste error output or logs.
  4. Code snapshot or demos on online code editor will be very helpful.

Pull requests

  1. Fork the repository.
  2. Create a branch from master.
  3. Update the source code (in *.ts files).
  4. Commit and push the changes with descriptive messages.
  5. Create a pull request to master.

Please note:

  • All pull requests should be tied to an issue, and all but the most trivial pull requests should be discussed beforehand.
  • Every PR needs 1 approving review to be merged into master (unless you are an administrator of the repo).
  • When PRs are made from a fork, the GitHub Actions script that updates and commits JS files will not succeed due to safety reasons. Instead, the JS files will have to be updated manually.