This document is to help the maintainers on how to traige new issues.
Adding a link to REVIEWING.md in CONTRIBUTING.md
Signed-off-by: Mohan Boddu <mboddu@redhat.com>
We want contributors to submit to the main branch of podman and not
branches without maintainer involvement.
Signed-off-by: Brent Baude <bbaude@redhat.com>
The doc has been reorganized and reordered. New sections have
been added as necessary to cover things not covered by the old
guide. Some sections were expanded (e.g. detailing differences
between E2E and System tests). Some sections that we did not
actually follow were removed.
Fixes https://issues.redhat.com/browse/RUN-2281
Signed-off-by: Matt Heon <mheon@redhat.com>
Per discussion within the team, we would like all bugfixes to be
referenced in commit messages as "Fixes:" (or "Fixes" with no
colon, for those who would like to type one less character). We
are going to add CI to enforce this on our LTS branches as we
should only be backporting bugfixes there.
Signed-off-by: Matt Heon <mheon@redhat.com>
As we want to get rid of the special titles convert the existing skips
to the only_if condition, this makes it more readable as we do not need
to negate so much.
Then add similar conditions for all test tasks, this removes the need to
a special title such as CI:DOCS as the logic is smart enough to only
docs changes when no source code was changed.
Update the documentation for the new logic and no longer point
contributors to the CI:DOCS title as it is gone now.
There is a bunch of duplication in the rules as yaml doesn't allow us to
share only parts of a string. To prevent unwanted drift a test case in
contrib/cirrus/cirrus_yaml_test.py is added to ensure all conditions
follow the same base ruleset.
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
Small usability improvements for our containerized validate target.
- Responds to SIGINT
- Exits if build fails, only validate if builds succeed
- Warns about potential of insufficient memory
- Document `make validatepr`
Signed-off-by: Ashley Cui <acui@redhat.com>
The contents of the "Prerequisite before buil"d section are given already
in a link in its "Prepare your environment" parent section and therefore
redundant. Let's remove it.
Signed-off-by: phoenix <felix.niederwanger@suse.com>
Adds the installation instructions for openSUSE, similar to the present
ones for Fedora and Debian/Ubuntu.
Tested on openSUSE Tumbleweed and Leap 15.6.
Signed-off-by: phoenix <felix.niederwanger@suse.com>
Old way: edit commit message, add magic string, re-push
New way: repo maintainer adds a Github label to PR, hits Rerun
I've looked and looked for the history behind this script
and why I didn't do it this way in the first place. I've
concluded that I just never thought of it.
Signed-off-by: Ed Santiago <santiago@redhat.com>
We had a number of references, mostly in docs, to the word master that
can now be changed to main. This PR does that and makes the project a
bit more inclusive.
[NO NEW TESTS NEEDED]
Signed-off-by: tomsweeneyredhat <tsweeney@redhat.com>
Adding "Bug Report" and "Feature Request" templates, this will
help with filing the tickets and also finding the information
once filed.
Signed-off-by: Mohan Boddu <mboddu@redhat.com>
This container hasn't been used/maintained in ages, remove the related
instructions from the contributions doc.
Fixes: #16415
Signed-off-by: Chris Evich <cevich@redhat.com>
Basically, acknowledge the need for dependencies and link
to Fedora specfile which is the only sane place to find
such a list.
Closes: #16365
Signed-off-by: Ed Santiago <santiago@redhat.com>
This adds a small bit of text so that new OSX devs can more easily find
the MacOS specific contributing guidelines.
Signed-off-by: Kirk Bater <kirk.bater@gmail.com>
- prerequisites in Fedora section has libseccomp-devel.x86_64 named twice
- bin/podman flag "-h" does not work, "--help" is required
Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>
Project IRC comms are moving to Libera. Update docs.
Confirmation cookie: libera-ieVeeGahbiaf1einguw1xav6bahquie
Signed-off-by: Ed Santiago <santiago@redhat.com>
I looked at the man pages and found that while they are consistent in their basic concept, many things concerning formatting are not.
For example, it is not consistent that options are behind an H4 header.
The biggest criticism, however, is how commands and options are handled when referencing them in a text.
There is no clear structure between the man pages regarding this. Sometimes backticks are used and sometimes they are written in italic.
Also, the formatting regarding the appearance of the commands is not consistent either.
I would like to propose a uniform formatting and, if accepted, apply it to all man pages.
Uniformity is very important to me and it should be clear to the user when reading several man pages what exactly their content and references are about.
Signed-off-by: Alexander Richter <67486332+Procyhon@users.noreply.github.com>
On each PR (with a few exceptions), check the list of git-touched
files, and abort if no tests are added. Include instructions
on how to bypass the check if tests really aren't needed.
Include a hardcoded exception list for PRs that only touch a
well-known subset of "safe" files: docs, .cirrus.yml, vendor,
version, hack, contrib, or *.md. This list is likely to need
tuning over time.
Add a test suite, but not one recognized by the new script
(because it's a "*.t" file), so: [NO TESTS NEEDED]
Signed-off-by: Ed Santiago <santiago@redhat.com>
Remove references on contrib/gate. The gating image is currently not
maintained and was replaced in the CI rewrite. We can disable builds
in Quay once the change is merged.
Note that running `make validate` in a container is still desired.
A similar approach may be re-added in the future.
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
Add a pull-request template that points to the section in the
contributing guidelines and to remind users to use the `[CI:DOCS]`
prefix if applicable.
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
Update the CONTRIBUTING.md to explain the use of the
new "In Progress" label in the Podman repository.
This emulates the verbiage in Buildah.
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Switch the libpod references to podman in the CONTRIBUTING.md.
Update the cirrus-ci link so we can get a green build again :)
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
A number of scripts relating to tooling used and the gate container
image were not exiting upon errors as intended. Coupled with
external service unavailability (i.e. downloading golangci-lint)
was observed to cause difficult to debug failures.
This change corrects the scripts inside/out of the gate container as
well as fixes many golang related path consistency problems vs other CI
jobs. After this change, all jobs use consistent path names reducing
the number of special-case overrides needed.
Lastly, I also made a documentation-pass, updating/correcting as needed,
including documenting a likely local validation-failure mode, related to
`$EPOCH_TEST_COMMIT`. This is dependent on the developers git
environment, so documentation is the only possible "fix".
Signed-off-by: Chris Evich <cevich@redhat.com>
The paths to the local libpod tree where missing the `./src` part which
ultimately lead to compilation errors. Also place the git trees into
containers/libpod and not into the user's GitHub root.
Reported in #podman on IRC.
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
Introduce a new part inside the contribution guide
who explain how to start to hack on libpod:
- setup environment
- install tools
- using make
- building podman
- test your changes locally
Signed-off-by: Hervé Beraud <hberaud@redhat.com>
Previously if you used the documented code validation command,
you would end up with your repository SELinux labels being changed. In
many cases this is not desirable. Update the documentation such that
the original source of the repository isn't touched in any way (prior
to making a copy of it in the container).
Also add a small (but important) note about building the container
image.
Signed-off-by: Chris Evich <cevich@redhat.com>
Having a standardized image allows uniform application of format and
lint checking across multiple host platforms. This ensures all
contributors and disparate CI systems to play by a common set of basic
rules. It also makes it easier to maintain the common rules over-time.
Signed-off-by: Chris Evich <cevich@redhat.com>
Add a section about describing changes in commit messages. GitHub tends
to drive the large part of discussions and change descriptions to the
corresponding pull requests and issues, but such information is lost in
the git history. Not providing sufficient information in commit
messages is painful for reviewing and can cause issues while debugging.
It also complicates studying source code, where reading commit messages
and the code's git history is a common approach to better understand the
code.
Following the descriptions should be enforced by the maintainers of the
libpod project. Pull requests containing commits without proper
descriptions should not be merged.
This change bases on the documentation of the Linux kernel v4.17:
https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html
Signed-off-by: Valentin Rothberg <vrothberg@suse.com>
