Skip to content

Commit

Permalink
Added "How to help" section
Browse files Browse the repository at this point in the history
  • Loading branch information
morevnaproject committed Oct 5, 2020
1 parent 2645e70 commit 8f9ab34
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 0 deletions.
28 changes: 28 additions & 0 deletions source/how_to_help.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. _how_to_help:


########################
How to Help
########################

Synfig is an open-source software, and “open-source” is all about community contributions! So even a regular (non-developer) user can help a lot! How? Read below.

**1. Help other users**

There are many people who are asking for help at `our forums <https://forums.synfig.org/>`_. If you already know how to solve particular problem - don’t hesitate to lend a hand to them!

**2. Report issues**

Found an issue? Report it to `our issue tracker <https://github.com/synfig/synfig/issues>`_! Also, we recommend to read `this guide <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_ on how to report bugs effectively.

**3. Help to test development releases**

Give a try to `development releases <https://www.synfig.org/download-development/>`_ and help to identify issues and weak places. The more people will test development release - the better stable one becomes!

**4. Help to test open Pull Requests**

You can help developers by giving your feedback about new improvements, which are proposed to be added into code (Pull Requests or PRs). This will help developers decide which features are ready to be included and allow to spot what should be improved. Check the list of open Pull Requests on `this page <https://github.com/synfig/synfig/pulls>`_ and read :ref:`testing_prs` for details.

**5. Help to translate user interface**

Translation of Synfig's user interface is takes place online `at Transifex platform <https://www.transifex.com/morevnaproject/synfig/>`_. You can help improve ttranslation to your language.
41 changes: 41 additions & 0 deletions source/how_to_help/testing_prs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. _testing_prs:


########################################
How to test changes in Pull Requests
########################################


1. Go to `list of Pull Requests <https://github.com/synfig/synfig/pulls>`_ and click any of them. For example, this one - https://github.com/synfig/synfig/pull/1737

2. Scroll down to the area showing checks (click on “Show all checks” if they are hidden).

.. image:: ./testing_prs_dat/screenshot_001.png
:width: 550px
:align: center

3. Click on the “Details” link on the opposite side of “continuous-integration/appveyor/pr”.

.. image:: ./testing_prs_dat/screenshot_002.png
:width: 550px
:align: center

4.Now you need to choose “Environment: MSYSTEM=MINGW64” for x64 Windows or “Environment: MSYSTEM=MINGW32” for x32.

.. image:: ./testing_prs_dat/screenshot_003.png
:width: 550px
:align: center

5. And then switch to the “Artifacts” tab.

.. image:: ./testing_prs_dat/screenshot_004.png
:width: 550px
:align: center

6. Click on “SynfigStudio-…” filename to download.

.. image:: ./testing_prs_dat/screenshot_005.png
:width: 550px
:align: center

Now you can unpack the downloaded file and run Synfig, which includes all modifications introduced in this particular PR. This is a portable version, so no need to install it.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Synfig User Manual
plugins.rst
releases.rst
about.rst
how_to_help.rst



Expand Down

0 comments on commit 8f9ab34

Please sign in to comment.