CONTRIBUTING: Update instructions/details

Author: ferdnyc

CONTRIBUTING.md

@@ -1,38 +1,46 @@
 ## How to contribute to OpenShot Video Editor
 
-#### **Did you find a bug?**
+### Submitting an Issue (bug report)
 
-* **Please check if this bug was already reported** by searching on GitHub under [Issues](https://github.com/OpenShot/openshot-qt/issues).
+* **Please check if this bug was already reported** by searching on GitHub under [Issues](https://github.com/OpenShot/openshot-qt/issues?q=+).
 
-* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/OpenShot/openshot-qt/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and the steps to reproduce the crash or issue.
+* If you're unable to find an existing report about the problem, [open a new issue](https://github.com/OpenShot/openshot-qt/issues/new?template=bug-report.md). Be sure to include a **title and clear description**, and fill in as much relevant information as possible. Include the steps to reproduce the crash or issue, and please note what operating system(s) you tried them on. (Some bugs only occur when using OpenShot on a particular OS.)
 
 * Please **attach log files** if you are reporting a crash. Otherwise, we will not be able to determine the cause of the crash.
 
-  _Please download our latest daily installer:_
+#### Reproducing a bug & collecting logs
 
-  1. www.openshot.org/download - click the '**Daily Builds**' button, then grab the latest build from the list.
-     (Use the buttons below to download installers for a different Operating System.)
-  2. Then enable 'Debug Mode (Verbose)' in the Preferences
-  3. Quit OpenShot and delete both log files:
-      * **Windows**: OpenShot stores its logs in your user profile directory (`%USERPROFILE%`, e.g. `C:\Users\username\`)
-        * **`%USERPROFILE%/.openshot_qt/openshot-qt.log`**
-        * **`%USERPROFILE%/.openshot_qt/libopenshot.log`**
-      * **Linux/MacOS**: OpenShot stores its logs in your home directory (`$HOME`, e.g. `/home/username/`)
-        * **`$HOME/.openshot_qt/openshot-qt.log`**
-        * **`$HOME/.openshot_qt/libopenshot.log`**
-  4. Re-launch OpenShot and trigger the crash as quickly as possible (to keep the log files small)
-  5. Attach **both** log files
+  1. _Please download our latest daily installer:_
+     www.openshot.org/download - click the '**Daily Builds**' button, then grab the latest build from the list.
+     (Use the buttons below the list to download installers for a different Operating System.)
+  2. **Only if the bug involves video playback or Export**, or if you were asked to by the OpenShot developers, enable 'Debug Mode (Verbose)' in the Preferences. Debug Mode adds no additional information for user interface or project-editing bugs.
+  3. Quit OpenShot and delete your log files, to ensure the files you submit contain only necessary information. (See below for logfile paths.)
+  4. Re-launch OpenShot and trigger the problem as quickly as possible, then immediately quit the program. This helps keeps the log files small and relevant.
+  5. Attach both log files to your issue. Github issue comments permit attaching `.log` files up to 2MB in size. You can insert the file(s) either by drag-and-drop, or using the link at the bottom of the comment edit field.
+  
+#### OpenShot log file locations  
 
-#### **Did you write a patch that fixes a bug?**
+##### Windows
+  * OpenShot stores its logs in your user profile directory (`%USERPROFILE%`, e.g. `C:\Users\username\`)
+    * **<code><var>%USERPROFILE%</var>\.openshot_qt\openshot-qt.log</code>**
+    * **<code><var>%USERPROFILE%</var>\.openshot_qt\libopenshot.log</code>**
 
-* Open a new GitHub pull request with the patch.
+##### Linux/MacOS
+  * OpenShot stores its logs in your home directory (`$HOME`, e.g. `/home/username/`)
+    * **<code><var>$HOME</var>/.openshot_qt/openshot-qt.log</code>**
+    * **<code><var>$HOME</var>/.openshot_qt/libopenshot.log</code>**
 
-* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+### Submitting a Pull Request (source code patch / bug fix)
 
-* Before submitting, please ensure your PR passes all build / compilation / and unit tests.
+* Fork the repository on Github, then create a new branch for your changes. Commit the patch(es), and finally open a new GitHub Pull Request from that branch.
 
-OpenShot Video Editor is a volunteer effort, and a labor of love. Please be patient with any issues you find, and feel free to get involved and help us fix them! 
+* Ensure the PR description clearly describes the problem and your solution. If the patch is related to an existing issue report, include the issue number in your description. Github recognizes trigger phrases such as "fixes #1234" or "closes #9999", and will automatically link your PR with the referenced issue(s).
+
+* After submitting, your PR will be run through a test build and various code-quality and style checks. Try to address any problems flagged by these checks. If OpenShot fails to build successfully with your changes, the PR cannot be merged until the problem is resolved.
 
+  Submitting "in-progress" code is fine, and can often be a good way to solicit feedback from other developers. Consider marking PRs that are unfinished or still under development with a the title that begins with "WIP", or convert the PR to draft status, to indicate to the developers that your changes are not yet ready for review.
+
+OpenShot Video Editor is a volunteer effort, and a labor of love. Please be patient with any issues you find, and feel free to get involved and help us fix them! 
 
 Thanks!