From 96ec9617f1bce7902748683e9a7d79a0c71ddcef Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 26 Jun 2025 14:36:26 +0300 Subject: [PATCH 1/3] CONTRIBUTING: Update instructions for creating virtualenv Signed-off-by: Povilas Kanapickas --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a960f44..e0d2b07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,11 +19,12 @@ Note: Some steps are OPTIONAL but all are RECOMMENDED. $ cd podman-compose ``` -2. (OPTIONAL) Create a Python virtual environment. Example using - [virtualenv wrapper](https://virtualenvwrapper.readthedocs.io/en/latest/): +2. (OPTIONAL) Create a Python virtual environment. Example using python builtin + `venv` module: ```shell - $ mkvirtualenv podman-compose + $ python3 -m venv .venv + $ . .venv/bin/activate ``` 3. Install the project runtime and development requirements: From d864e195ceb78621c2d2d45e172d2b430c8fef32 Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 26 Jun 2025 14:36:27 +0300 Subject: [PATCH 2/3] CONTRIBUTING: Update instructions on commit message Signed-off-by: Povilas Kanapickas --- CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0d2b07..437bea8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,9 +61,15 @@ Note: Some steps are OPTIONAL but all are RECOMMENDED. - Make sure you include a `Signed-off-by` message in your commits. Read [this guide](https://github.com/containers/common/blob/main/CONTRIBUTING.md#sign-your-prs) to learn how to sign your commits. - - In the commit message, reference the Issue ID that your code fixes and a brief description of - the changes. - Example: `Fixes #516: Allow empty network` + - In the commit message body, reference the Issue ID that your code fixes and a brief description of the changes. + Example: + ``` + Allow empty network + + + + Fixes https://github.com/containers/podman-compose/issues/516 + ``` 9. Open a pull request to `containers/podman-compose` and wait for a maintainer to review your work. ## Adding new commands From 0de04b32bbbe08b5978bdf629e4d485078ede413 Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 26 Jun 2025 14:36:28 +0300 Subject: [PATCH 3/3] CONTRIBUTING: Suggest contributors to split their commits Signed-off-by: Povilas Kanapickas --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 437bea8..28cd296 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,6 +70,16 @@ Note: Some steps are OPTIONAL but all are RECOMMENDED. Fixes https://github.com/containers/podman-compose/issues/516 ``` + - If your commit requires a refactoring, first do the refactoring and + commit it separately before starting feature work. This makes the + pull request easier to review. Additionally, pull request will be + less risky, because if it breaks something, it's way easier to + isolate the offending code, understand what's broken and fix it. + Due to the latter reason it's best to commit in as many independent + commits as reasonable. + + This will result in pull requests being merged much faster. + 9. Open a pull request to `containers/podman-compose` and wait for a maintainer to review your work. ## Adding new commands