Skip to content

Latest commit

 

History

History
162 lines (116 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

162 lines (116 loc) · 6.42 KB
Raw

Contributing Guide

Welcome to the DNF5 project! We are glad that you want to contribute!

We welcome your feedback on different areas of our project, including the following:

  • Problems found during a new developer environment setup.
  • Gaps in our documentation.
  • Bugs in automation scripts.

If you are experiencing problems with the project, let us know by opening an issue. If you want to file a bug on Fedora, you can open the bug in the Bugzilla tool.

Ways to contribute

We welcome different types of contributions, including the following:

Finding an issue

If you are a new contributor, you can search for issues with the good first issue label. These issues are suitable for contributors who are not core maintainers and want to get familiar with the codebase.

Note that sometimes there can be no issues with the good first issue label. Do not worry! There is likely still something for you to work on. If you want to contribute but you do not know where to start or cannot find a suitable issue, ask for help by reaching out to us on one of our channels.

If there is an issue that you would like to work on, add a comment saying that you want to work on this issue, for example, "I want to work on this", and assign the issue to yourself.

Asking for help

If you need any help when contributing to the project, reach out to us either of the following ways:

  • Leave a comment in the original github issue.
  • Send a message to our mailing list: [email protected]
  • Ask us on our IRC channel: #dnf

Submitting a contribution

Once you have a contribution ready, complete the following steps to submit the contribution:

  1. Submit a pull request (PR).
    1. Set the necessary labels.
      • If you need help while working on the PR, set the work in progress label and wait for the PR to be triaged. Triaging usually happens on Mondays or Thursdays.
      • If you are ready for a code review by one of the maintainers, set the ready for review label.
  2. Review the PR.
    1. Discuss the PR with one of the maintainers. Note that the maintainers might request some changes.
    2. Review the PR again.
  3. Merge the PR.

Setting up a development environment

To setup a development environment, complete the following steps:

  1. Install build requirements:

    dnf builddep dnf5.spec #[--define '_without_<option> 1 ...]

  2. Build DNF5:

    mkdir build
cd build
cmake ..
# or cmake .. [-DWITH_<OPTION>=<ON|OFF> ...]
make

  3. Run the unit-tests. To run the tests, follow the steps to build the code and then run this code:

    # from the 'build' directory
CTEST_OUTPUT_ON_FAILURE=1 make test

    Alternatively, you can execute tests in a verbose mode:

    # from the 'build' directory
make test ARGS='-V'

  4. Install DNF5. To install the built package, we recommend to build an rpm package.

    You can build the rpm package either of the following ways:

    • Build rpms by using tito:

      tito build --rpm --test

    • Build rpms from git:

      export PREFIX=$(rpmspec dnf5.spec -q --srpm --qf '%{name}-%{version}'); git archive --format=tar.gz --prefix=$PREFIX/ HEAD > $PREFIX.tar.gz
rpmbuild -ba --define "_sourcedir $(pwd)" dnf5.spec #[--with=<option>|--without=<option> ...]

Pull request checklist

When you submit your pull request or push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks. However, note that there are more criteria that your pull request must pass before we can accept and merge it. We recommend that you ensure the following locally before you submit your code:

  • Code must build.

    Ensure that your code builds locally unless you need some help from us or you need us to review work in progress changes.

  • Code must be tested.

    If your pull request includes new or modified functionality within the library, we kindly request that you provide matching unit tests in the project's test directory to cover these changes. However, if the changes only affect the command-line interface, you can provide related CI tests in the ci-dnf-stack component. If you need our assistance, ask the maintainers for help.

  • Code must pass sanity checks.

    Test the sanity of the codebase by performing pre-commit checks. In the dnf5 directory, run the following commands:

    pre-commit install
git add _<your_changes>_
git commit -m "_<your_commit>_"
...
Check the results.

    All checks will run as part of a PR action on GitHub. Therefore, make sure not to skip the checks if you do not want to amend your contribution.

    As part of pre-commit checks, we perform checks such as trailing whitespaces, end of file fixes, clang-format, and rpmlint checks. For more information, see .pre-commit-config.yml.