> For the complete documentation index, see [llms.txt](https://indigo-dc.gitbook.io/udocker/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://indigo-dc.gitbook.io/udocker/contributing.md).

# Contributing

## Introduction

Thanks for considering contributing to udocker. Contributions to udocker are welcome. You can contribute by improving the documentation, submit bug reports, provide feature requests, or writing code for udocker its installation and testing.

## Ground Rules

We aim at having portability, udocker is meant to be executed both on older distributions (such as CentOS 6) and newer, so beware of which python features you use and whether they are supported in older distributions.

The current Python 2 version of udocker is meant to be very easily moved between hosts, and submitted to batch systems, that's why we have everything in a single Python script.

Development work on a Python 3 version is ongoing in branch devel3 This version supports Python 2 and Python 3 and is modular.

## Repositories

* For udocker: <https://github.com/indigo-dc/udocker>
* For PRoot: <https://github.com/jorge-lip/proot-udocker>
* For libfakechroot-glibc: <https://github.com/jorge-lip/libfakechroot-glibc-udocker>
* For libfakechroot-musl: <https://github.com/jorge-lip/libfakechroot-musl-udocker>
* For patchelf: <https://github.com/jorge-lip/patchelf-udocker>

## How to report a bug

If you find a security vulnerability, do NOT open an issue. Email <udocker@lip.pt> instead.

Other issues and or feature enhancements can be communicated on GitHub <https://github.com/indigo-dc/udocker/issues>

## Code contributions

* Perform pull requests against the devel3 branch for the python 3 based version: <https://github.com/indigo-dc/udocker/tree/devel3>
* Perform pull requests against the devel branch for maintenance of the old python 2 based version <https://github.com/indigo-dc/udocker/tree/devel>
* Please check you Python code with pylint.
* For new features please also provide unit tests.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://indigo-dc.gitbook.io/udocker/contributing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.