extern/podman-compose
1
0
Fork 1
mirror of https://github.com/containers/podman-compose.git synced 2025-07-01 13:10:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1249 from p12tic/update-contributing

Browse Source 
Update CONTRIBUTING.md
This commit is contained in:
Povilas Kanapickas
2025-06-26 14:59:42 +03:00
committed by GitHub
parent b48317c22b 0de04b32bb
commit e789d98bf0
1 changed files with 23 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -19,11 +19,12 @@ Note: Some steps are OPTIONAL but all are RECOMMENDED.
$ cd podman-compose $ cd podman-compose
``` ```
2. (OPTIONAL) Create a Python virtual environment. Example using 2. (OPTIONAL) Create a Python virtual environment. Example using python builtin
[virtualenv wrapper](https://virtualenvwrapper.readthedocs.io/en/latest/): `venv` module:
```shell ```shell
$ mkvirtualenv podman-compose $ python3 -m venv .venv
$ . .venv/bin/activate
``` ```
3. Install the project runtime and development requirements: 3. Install the project runtime and development requirements:
@ -60,9 +61,25 @@ Note: Some steps are OPTIONAL but all are RECOMMENDED.
- Make sure you include a `Signed-off-by` message in your commits. - 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) Read [this guide](https://github.com/containers/common/blob/main/CONTRIBUTING.md#sign-your-prs)
to learn how to sign your commits. to learn how to sign your commits.
- In the commit message, reference the Issue ID that your code fixes and a brief description of - In the commit message body, reference the Issue ID that your code fixes and a brief description of the changes.
the changes. Example:
Example: `Fixes #516: Allow empty network` ```
Allow empty network
<description, such as links to the compose spec and so on>
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. 9. Open a pull request to `containers/podman-compose` and wait for a maintainer to review your work.
## Adding new commands ## Adding new commands