contributing

Author: sgong-pdftron

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contributing to PDFTron - Flutter
+
+## 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.
+4. Commit and push the changes with descriptive messages.
+5. Create a pull request to `master`.
+
+\* Please note that all pull requests should be tied to an issue, and all but the most trivial pull requests should be discussed beforehand.

README.md

@@ -235,5 +235,8 @@ Initializes PDFTron SDK
 
 Opens a document in the viewer
 
+## Contributing
+See [Contributing](./CONTRIBUTING.md)
+
 ## License
 See [License](./LICENSE)