Blame README.rst

Packit 3a9065
##################
Packit 3a9065
 Core DNF Plugins
Packit 3a9065
##################
Packit 3a9065
Packit 3a9065
Core plugins to use with `DNF package manager <https://github.com/rpm-software-management/dnf>`_.
Packit 3a9065
Packit 3a9065
==============
Packit 3a9065
 Installation
Packit 3a9065
==============
Packit 3a9065
Packit 3a9065
RPM packages are available in official Fedora repositories::
Packit 3a9065
Packit 3a9065
   dnf install dnf-plugins-core
Packit 3a9065
Packit 3a9065
Nigthly builds can be installed from `copr repository <https://copr.fedorainfracloud.org/coprs/rpmsoftwaremanagement/dnf-nightly/>`_.
Packit 3a9065
Packit 3a9065
Packit 3a9065
======================
Packit 3a9065
 Building from source
Packit 3a9065
======================
Packit 3a9065
Packit 3a9065
From the DNF git checkout directory::
Packit 3a9065
Packit 3a9065
    mkdir build;
Packit 3a9065
    pushd build;
Packit 3a9065
    cmake .. && make;
Packit 3a9065
    popd;
Packit 3a9065
Packit 3a9065
Then to run DNF::
Packit 3a9065
Packit 3a9065
    PYTHONPATH=`readlink -f .` bin/dnf <arguments>
Packit 3a9065
Packit 3a9065
===============
Packit 3a9065
 Running tests
Packit 3a9065
===============
Packit 3a9065
Packit 3a9065
From the DNF git checkout directory::
Packit 3a9065
Packit 3a9065
    mkdir build;
Packit 3a9065
    pushd build;
Packit 3a9065
    cmake .. && make ARGS="-V" test;
Packit 3a9065
    popd;
Packit 3a9065
Packit 3a9065
==============
Packit 3a9065
 Contribution
Packit 3a9065
==============
Packit 3a9065
Packit 3a9065
Here's the most direct way to get your work merged into the project.
Packit 3a9065
Packit 3a9065
1. Fork the project
Packit 3a9065
#. Clone down your fork
Packit 3a9065
#. Implement your feature or bug fix and commit changes
Packit Service 6746a6
#. If the change fixes a bug at `Red Hat bugzilla <https://bugzilla.redhat.com/>`_, or if it is important to the end user, add the following block to the commit message::
Packit Service 6746a6
Packit Service 6746a6
    = changelog =
Packit Service 6746a6
    msg:           message to be included in the changelog
Packit Service 6746a6
    type:          one of: bugfix/enhancement/security (this field is required when message is present)
Packit Service 6746a6
    resolves:      URLs to bugs or issues resolved by this commit (can be specified multiple times)
Packit Service 6746a6
    related:       URLs to any related bugs or issues (can be specified multiple times)
Packit Service 6746a6
Packit Service 6746a6
   * For example::
Packit Service 6746a6
Packit Service 6746a6
       = changelog =
Packit Service 6746a6
       msg: [download] Respect repo priority
Packit Service 6746a6
       type: bugfix
Packit Service 6746a6
       resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1800342
Packit Service 6746a6
Packit Service 6746a6
   * For your convenience, you can also use git commit template by running the following command in the top-level directory of this project::
Packit Service 6746a6
Packit Service 6746a6
       git config commit.template ./.git-commit-template
Packit Service 6746a6
Packit Service 6746a6
#. In a separate commit, add your name and email under ``DNF-PLUGINS-CORE CONTRIBUTORS`` section in the `authors file <https://github.com/rpm-software-management/dnf-plugins-core/blob/master/AUTHORS>`_ as a reward for your generosity
Packit 3a9065
#. Push the branch up to your fork
Packit 3a9065
#. Send a pull request for your branch
Packit 3a9065
Packit Service 6746a6
Please do not create pull requests with translation (.po) file improvements. Fix the translation on `Fedora Weblate <https://translate.fedoraproject.org/projects/dnf/>`_ instead.
Packit 3a9065
Packit 3a9065
===============
Packit 3a9065
 Documentation
Packit 3a9065
===============
Packit 3a9065
Packit 3a9065
The DNF-PLUGINS-CORE package distribution contains man pages ``dnf.plugin.*(8)``. It is also possible to read the `DNF-PLUGINS-CORE documentation <http://dnf-plugins-core.readthedocs.org>`_ online.
Packit 3a9065
Packit 3a9065
====================
Packit 3a9065
 Bug reporting etc.
Packit 3a9065
====================
Packit 3a9065
Packit 3a9065
Please report discovered bugs to the `Red Hat bugzilla <https://bugzilla.redhat.com/>`_ following this `guide <https://github.com/rpm-software-management/dnf/wiki/Bug-Reporting>`_. If you planed to propose the patch in the report, consider `contribution`_ instead.
Packit 3a9065
Packit 3a9065
Freenode's irc channel ``#yum`` is meant for discussions related to both Yum and DNF. Questions should be asked there, issues discussed. Remember: ``#yum`` is not a support channel and prior research is expected from the questioner.