File: contributing.rst

package info (click to toggle)
openshot-qt 2.4.3%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 107,544 kB
  • sloc: python: 289,246; xml: 3,101; makefile: 214; sh: 69
file content (80 lines) | stat: -rw-r--r-- 3,120 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.. Copyright (c) 2008-2018 OpenShot Studios, LLC
 (http://www.openshotstudios.com). This file is part of
 OpenShot Video Editor (http://www.openshot.org), an open-source project
 dedicated to delivering high quality video editing and animation solutions
 to the world.

.. OpenShot Video Editor is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

.. OpenShot Video Editor is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

.. You should have received a copy of the GNU General Public License
 along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.


Contributing
============

Did you find a bug?
-------------------

-  **Please check if this bug was already reported** by searching on
   GitHub under
   `Issues <https://github.com/OpenShot/openshot-qt/issues>`__.

-  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.

-  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:
"""""""""""""""""""""""""""""""""""""""""""
1. `www.openshot.org/download <https://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

Did you write a patch that fixes a bug?
---------------------------------------

-  Open a new GitHub pull request with the patch.

-  Ensure the PR description clearly describes the problem and solution.
   Include the relevant issue number if applicable.

-  Before submitting, please ensure your PR passes all build /
   compilation / and unit tests.

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!

OpenShot Team