How to Contribute to GIMP Documentation

Contributing improvements to the GIMP documentation team is an accessible way to support the open-source creative community. Contributors can submit updates by reporting inaccuracies or typos, editing DocBook XML source files directly, opening merge requests through the official GNOME GitLab repository, or translating content into other languages. This guide outlines the exact steps required to prepare, submit, and discuss your documentation contributions with the GIMP team.

1. Report Issues on GitLab

If you notice a typo, broken link, or outdated information and do not want to edit the code directly, you can submit an issue:

  1. Visit the official GNOME GitLab instance and navigate to the GNOME/gimp-help repository.
  2. Create or log in to your GNOME GitLab account.
  3. Open a new issue under the Issues tab.
  4. Clearly state the problem, provide the URL or manual section name, and describe the suggested correction.

2. Submit Changes via Merge Requests

For direct edits, code updates, or writing new sections, submitting a Git Merge Request (MR) is the standard procedure.

Step 1: Fork the Repository

Go to the gimp-help project on GNOME GitLab and click Fork to create a personal copy of the repository.

Step 2: Clone and Create a Branch

Clone your fork locally and create a dedicated branch for your changes:

git clone https://gitlab.gnome.org/YOUR-USERNAME/gimp-help.git
cd gimp-help
git checkout -b fix-documentation-topic

Step 3: Edit the Source Files

GIMP documentation is written primarily in XML using the DocBook format:

  • Locate the relevant XML files within the src/ directory.
  • Make your text or structural edits using any standard text editor.
  • Ensure your XML tags are properly closed and adhere to existing styling conventions.

Step 4: Validate and Test Build

Before submitting your work, build the documentation locally to check for XML syntax errors or broken formatting. Refer to the repository’s INSTALL or README file for the specific build requirements and commands (typically requiring tools like xsltproc and gettext).

Step 5: Commit and Open a Merge Request

  1. Commit your changes with a clear, concise commit message explaining the update.

  2. Push the branch to your GitLab fork:

    git push origin fix-documentation-topic

  3. Navigate to your fork on GitLab and click Create Merge Request.

  4. Describe the changes you made in detail and submit the request for review by the documentation maintainers.

3. Contribute Translations

GIMP documentation translations are managed through GNOME’s translation infrastructure, Damned Lies:

  1. Join the GNOME Translation Project for your specific language team.
  2. Coordinate with your language team coordinator to prevent duplicate work.
  3. Translate the .po files associated with the gimp-help module and submit them through the Damned Lies platform.

4. Contact the Documentation Team

If you plan to write extensive new sections or need guidance on complex topics, contact the team before starting:

  • IRC / Matrix: Connect to the #gimp or #gimp-docs channels on the GIMP or GNOME Matrix/IRC networks.
  • Mailing Lists: Participate in discussions on the official GIMP developer mailing lists to propose large-scale structural changes or ask technical questions.