Skip to content

Update quickstart for 'Contribute with Code' #7320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ggainey merged 1 commit into from
Feb 13, 2026
Merged

Update quickstart for 'Contribute with Code' #7320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/7319.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed the quickstart instructions on how to contribute with code as well as links to more comprehensive guides.
24 changes: 14 additions & 10 deletions docs/dev/tutorials/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,32 @@ It is a CLI tool that uses `docker/podman-compose` and [Pulp OCI Images](https:/
To set it up, follow these steps:

```bash
# 1. clone repos to the same basedir (pulpcore is required)
# 1. clone required repos to the same basedir
git clone https://github.com/pulp/oci_env.git
git clone https://github.com/pulp/pulpcore.git
git clone https://github.com/pulp/pulp-openapi-generator.git # required for 'generate-client' below
Copy link
Contributor

@ggainey ggainey Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


# 1.1 add more repos as necessary to the same basedir
git clone https://github.com/pulp/pulp_rpm.git

# 2. install oci-env client
cd oci_env
pip3 install -e client

# 3. use minimal compose.env
# At least add pulpcore to DEV_SOURCE_PATH like this: DEV_SOURCE_PATH=pulpcore
cp compose.env.example compose.env

# 4. build the images and do basic setup
# 4. build the images and start the service
oci-env compose build
oci-env compose up

# 5. do basic setup
oci-env generate-client -i
oci-env generate-client -i pulp_file

# 5. start the service
oci-env compose up
```

A more comprehensive guide on setting up the dev environment is documented [here](#).
A more comprehensive guide on setting up the dev environment is documented [here](site:oci_env/docs/dev/tutorials/quickstart/).

### 2. Make and test changes

Expand All @@ -52,11 +56,11 @@ oci-env test -i -p pulp_rpm functional
oci-env test -p pulp_rpm functional -k test_mychages
```

A more comprehensive guide on running tests is documented [here](#).
A more comprehensive guide on running tests is documented [here](site:oci_env/docs/dev/guides/run-tests/).

### 3. Update the changelog entry

Pulp uses [towncrier](#) to manage its changelog.
Pulp uses [towncrier](https://towncrier.readthedocs.io/en/stable/) to manage its changelog.

It requires that you have a related GitHub issue number, except for trivial changes (such as typo fixes).
In those cases the entry is no required at all.
Expand All @@ -83,7 +87,7 @@ The changelog message should use past simple tense and describe the change being
echo "Added API that allows users to export a repository version to disk." > CHANGES/plugin_api/3245.feature
```

A more comprehensive guide on using towncrier in the Pulp project is documented [here](#).
A more comprehensive guide on using towncrier in the Pulp project is documented [here](site:pulpcore/docs/dev/guides/git/#changelog-update).

### 4. Commit and Submit a PR

Expand All @@ -108,4 +112,4 @@ the worker configuration.
closes #1392
```

A more comprehensive guide on using git in the Pulp project is documented [here](#).
A more comprehensive guide on using git in the Pulp project is documented [here](site:pulpcore/docs/dev/guides/git/).