summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAge
* Fix test block bypass instructionsJakob Ahrer2022-05-26
| | | | | | | | A new string was added in 521c0cb and the old one removed with 2ed31f9 [NO NEW TESTS NEEDED] Signed-off-by: Jakob Ahrer <jakob@ahrer.dev>
* Globally replace http:// with https://Daniel J Walsh2021-08-27
| | | | | | [NO TESTS NEEDED] Hopefully existing tests will find issues. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* [CI:DOCS] point IRC to libera.chatEd Santiago2021-05-29
| | | | | | | | Project IRC comms are moving to Libera. Update docs. Confirmation cookie: libera-ieVeeGahbiaf1einguw1xav6bahquie Signed-off-by: Ed Santiago <santiago@redhat.com>
* Manpage syntax proposalAlexander Richter2021-05-27
| | | | | | | | | | | | 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>
* CI: smoke test: insist on adding tests on PRsEd Santiago2021-01-19
| | | | | | | | | | | | | | | | 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 contrib/gateValentin Rothberg2020-11-17
| | | | | | | | | | | 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 PR templateValentin Rothberg2020-11-04
| | | | | | | | 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>
* [CI:DOCS] Fix broken CI readme linksChris Evich2020-10-30
| | | | Signed-off-by: Chris Evich <cevich@redhat.com>
* add prerequisite section before building binaries3sky2020-10-07
| | | | Signed-off-by: 3sky <3sky@protonmail.com>
* [CI:DOCS] Add 'In Progress' note to CONTRIBUTING.mdTomSweeneyRedHat2020-09-21
| | | | | | | | 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>
* [CI:DOCS] Switch more references from libpod to podmanPaul Holzinger2020-08-27
| | | | | | | 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>
* Switch all references to github.com/containers/libpod -> podmanDaniel J Walsh2020-07-28
| | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Cirrus: Fix gate image & false-positive exitsChris Evich2020-03-02
| | | | | | | | | | | | | | | | | | | 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>
* drop OWNERS link for CONTRIBUTING.mdValentin Rothberg2019-09-25
| | | | | | | It was pointing to K8s docs and didn't really fit into the communications context. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Fix spelling mistakes in man pages and other docsDaniel J Walsh2019-07-11
| | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* CONTRIBUTING.md: fix project pathsValentin Rothberg2019-07-08
| | | | | | | | | 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>
* CONTRIBUTING.md: fix typoPetr Vaněk2019-06-15
| | | | Signed-off-by: Petr Vaněk <arkamar@atlas.cz>
* Mention the new Podman mailing list in contributing.mdMatthew Heon2019-06-13
| | | | Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* docs: Add CI section and linksChris Evich2019-05-30
| | | | Signed-off-by: Chris Evich <cevich@redhat.com>
* [ci skip] Critical note about merge botChris Evich2019-02-28
| | | | Signed-off-by: Chris Evich <cevich@redhat.com>
* Introduce how to start to hack on libpod.Hervé Beraud2019-02-22
| | | | | | | | | | | | 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>
* [skip ci] Docs: Add Bot Interactions sectionChris Evich2019-01-04
| | | | Signed-off-by: Chris Evich <cevich@redhat.com>
* [skip ci] Gate: Update docs w/ safer local commandChris Evich2018-12-19
| | | | | | | | | | | | | 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>
* Standardized container image for gofmt and lintChris Evich2018-11-13
| | | | | | | | | 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>
* CONTRIBUTING.md: add section about describing changesValentin Rothberg2018-10-29
| | | | | | | | | | | | | | | | | | | | 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>
* switch projectatomic to containersDaniel J Walsh2018-08-16
| | | | | | | | | | Need to get some small changes into libpod to pull back into buildah to complete buildah transition. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #1270 Approved by: mheon
* Add pointers for Integration Tests to docsTomSweeneyRedHat2018-06-06
| | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> Closes: #910 Approved by: rhatdan
* CONTRIBUTING: Document PR approval and link to OWNERSW. Trevor King2018-04-28
| | | | | | | | | | | | Remove a dead "Becoming a Maintainer" link and that stub section, since libpod currently doesn't document that process. By leaving it undocumented, maintainer changes falls back to the usual pull-request review process. Signed-off-by: W. Trevor King <wking@tremily.us> Closes: #688 Approved by: rhatdan
* README: Link to CONTRIBUTING.mdW. Trevor King2018-04-27
| | | | | | | | | | | | | | | | Make that information more easily discoverable. And since CONTRIBUTING.md already mentions IRC, we can drop the IRC reference from the README to DRY things up. Also update CONTRIBUTING.md to replace the stale #cri-o reference left over from the initial libpod/podman fork. While I was touching this line, I also shuffled some of the wording around to tighten that sentence up. Signed-off-by: W. Trevor King <wking@tremily.us> Closes: #687 Approved by: rhatdan
* Ran spell checker through all man pagesDaniel J Walsh2018-01-29
| | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #269 Approved by: TomSweeneyRedHat
* Prune Server package. Convert to new github location.Matthew Heon2017-11-01
| | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com>
* Initial checkin from CRI-O repoMatthew Heon2017-11-01
Signed-off-by: Matthew Heon <matthew.heon@gmail.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-08 07:26:20 +0000