Blame doc/project_settings.rst

Pierre-Yves Chibon abdeee
Project settings
Pierre-Yves Chibon abdeee
================
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Each project have a number of options that can be tweaked in the settings
Pierre-Yves Chibon abdeee
page of the project which is accessible to the person having full commits
Pierre-Yves Chibon abdeee
to the project.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
This page presents the different settings and there effect.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Issue tracker
Pierre-Yves Chibon abdeee
-------------
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
This boolean simply enables or disables the issue tracker for the project.
Pierre-Yves Chibon abdeee
So if you are tracking your ticket on a different system, you can simply
Pierre-Yves Chibon abdeee
disable reporting issue on pagure by un-checking this option.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Project documentation
Pierre-Yves Chibon abdeee
---------------------
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pagure offers the option to have a git repository specific for the
Pierre-Yves Chibon abdeee
documentation of the project.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
This repository is then accessible under the ``Docs`` tab in the menu of the
Pierre-Yves Chibon abdeee
project.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
If you prefer to store your documentation elsewhere or maybe even within
Pierre-Yves Chibon abdeee
the sources of the project, you can disable the ``Docs`` tab by un-checking
Pierre-Yves Chibon abdeee
this option.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pull-request
Pierre-Yves Chibon abdeee
------------
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pagure offers the option to fork a project, make changes to it and then ask
Pierre-Yves Chibon abdeee
the developer to merge these changes into the project. This is similar to
Pierre-Yves Chibon abdeee
the pull-request mechanism on GitHub or GitLab.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
However, some projects may prefer receiving patches by email on their list
Pierre-Yves Chibon abdeee
or via another hosting plateform or simply do not wish to use the
Pierre-Yves Chibon abdeee
pull-request mechanism at all. Un-checking this option will therefore
Pierre-Yves Chibon abdeee
prevent anyone from opening a pull-request against this project.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
.. note:: disabling pull-requests does *not* disable forking the projects.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Only assignee can merge pull-request
Pierre-Yves Chibon abdeee
------------------------------------
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
This option can be used for project wishing to institute a strong review
Pierre-Yves Chibon abdeee
workflow where pull-request are first assigned then merged.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
If this option is enabled, only the person assigned to the pull-request
Pierre-Yves Chibon abdeee
can merge it.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Minimum score to merge pull-request
Pierre-Yves Chibon abdeee
-----------------------------------
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
This option can be used for project wishing to enforce having a minimum
Pierre-Yves Chibon abdeee
number of people reviewing a pull-request before it can be merged.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
If this option is enabled, anyone can vote in favor or against a pull-request
Pierre-Yves Chibon abdeee
and the sum of the votes in favor minus the sum of the votes againsts give
Pierre-Yves Chibon abdeee
the pull-request a score that should be equal or great to the value
Pierre-Yves Chibon abdeee
entered in this option for the pull-request to be allowed to be merged.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
.. note:: Only the main comments (ie: not in-line) are taken into account
Pierre-Yves Chibon abdeee
          to calculate the score of the pull-request.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
To vote in favor of a pull-request, use either:
Pierre-Yves Chibon abdeee
* ``+1``
Pierre-Yves Chibon abdeee
* ``:thumbsup:``
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
To vote against a pull-request, use either:
Pierre-Yves Chibon abdeee
* ``-1``
Pierre-Yves Chibon abdeee
* ``:thumbsdown:``
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
.. note:: Pull-Request reaching the minimum score are not automatically merged
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
.. note:: Anyone can vote on the pull-request, not only the contributors.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
Web-hooks
Pierre-Yves Chibon abdeee
---------
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon 9c66ac
Pagure offers the option of sending notification about event happening on a
Pierre-Yves Chibon 9c66ac
project via [web-hooks|https://en.wikipedia.org/wiki/Webhook]. This option
Pierre-Yves Chibon 9c66ac
is off by default and can be turned on for a pagure instance in its
Pierre-Yves Chibon 9c66ac
configuration file.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
The URL of the web-hooks can be entered in this field.
Pierre-Yves Chibon abdeee
Pierre-Yves Chibon abdeee
.. note:: See the ``notifications`` documentation to learn more about
Pierre-Yves Chibon abdeee
          web-hooks in pagure and how to use them.