Skip to content
Open
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b6a8433
add Updating contents and UI images section
adiati98 Nov 19, 2025
d593555
rename image files for consistency
adiati98 Nov 19, 2025
62f0f47
Merge branch '5.2' into feat/add-section-contributing
adiati98 Nov 19, 2025
f305d20
fix typo: change community handbook to user docs
adiati98 Nov 20, 2025
1fea053
move contents info to admonition to avoid repetition
adiati98 Nov 20, 2025
f6fa781
change examples to reflect user docs and clarify some instructions
adiati98 Nov 20, 2025
05b6c5d
Merge branch 'feat/add-section-contributing' of https://github.com/ma…
adiati98 Nov 20, 2025
1ca4456
add Git cherry-pick section
adiati98 Nov 20, 2025
4edef2d
add images for git cherry-pick section
adiati98 Nov 20, 2025
27fe7a0
remove admonition and incorporate the info in the opening paragraph f…
adiati98 Nov 20, 2025
b4c7a37
fix: change passive to active voice
adiati98 Nov 20, 2025
06b1dbb
add word rebase to accept.txt
adiati98 Nov 20, 2025
db61911
fix: change passive to active voice
adiati98 Nov 20, 2025
4c7717d
fix: change vscode to vs code for consistency
adiati98 Nov 20, 2025
ee95531
Merge branch 'feat/add-section-contributing' of https://github.com/ma…
adiati98 Nov 20, 2025
895b24b
Merge branch '5.2' into feat/add-section-contributing
adiati98 Nov 27, 2025
41ac1ad
update the Updating contents and UI images section
adiati98 Dec 2, 2025
65b7446
fix: grammars and adjust wordings
adiati98 Dec 2, 2025
eee84fa
Merge branch 'feat/add-section-contributing' of https://github.com/ma…
adiati98 Dec 2, 2025
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
114 changes: 104 additions & 10 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [Ways to create a new branch](#ways-to-create-a-new-branch)
- [Push changes to the remote repository](#push-changes-to-the-remote-repository)
- [Create a PR](#create-a-pr)
- [Git cherry-pick](#git-cherry-pick)
- [Getting started](#getting-started)
- [1. On GitHub](#1-on-github)
- [2. GitHub Codespaces](#2-github-codespaces)
Expand All @@ -32,6 +33,7 @@
- [Create a new link](#create-a-new-link)
- [Check broken links](#check-broken-links)
- [Working with Vale](#working-with-vale)
- [Updating contents and UI images](#updating-contents-and-ui-images)
- [Credit](#credit)

---
Expand Down Expand Up @@ -73,7 +75,7 @@
1. Ensure that you address one issue in one PR. If you work on multiple issues, work on them separately and create one PR to address each issue.
2. Make sure you give clear information about your changes in your PR:

- **A title**. The PR title must describe your changes. For example: `Convert Marketer section into RST`.
- **A title**. The PR title must describe your changes. For example: `Add WordPress Plugin documentation`.
- **A description**. A clear description can help PR reviewers understand what kind of changes you made in your PR. It's always good to walk through the process of how a reviewer can test your changes.
- **A related issue**. [Link the issue number](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) that you worked on and add a keyword of 'Closes', 'Fixes', or 'Resolves' in front of it. For example, `Closes #123`, `Fixes #234`, etc. You can find the issue number right next to the issue's title. Linking the issue number automatically closes your issue once your PR gets merged.

Expand Down Expand Up @@ -125,7 +127,7 @@
>
> The Mautic User Documentation contains multiple branches that represent specific versions of Mautic. You should clone each branch into its own dedicated folder and make your changes within the appropriate folder.
>
> So, for example, when you need to make documentation changes for Mautic versions 6 and 7, clone the branch `6.0` and save it in a folder, then clone the branch `7.0` and save it in a separate folder. You can name the folder anything you want, but it's best to reflect the branch name. For example, use names like `user-docs-6`, `user-docs-7`, and so on.
> So, for example, when you need to make documentation changes for Mautic versions 5 and 6, clone the branch `5.2` and save it in a folder, then clone the branch `6.0` and save it in a separate folder. You can name the folder anything you want, but it's best to reflect the branch name. For example, use names like `user-docs-5`, `user-docs-6`, and so on.
Follow the steps below to clone your forked repository:

Expand Down Expand Up @@ -260,7 +262,7 @@
1. Go to [https://github.com/mautic/user-documentation](https://github.com/mautic/user-documentation) and click the green button that prompts you to create a PR.
2. **This step is crucial.** Each branch contains documentation for a specific version of Mautic. You must base your PR on the branch that corresponds to the version you are modifying. If you don't, your changes may apply to the wrong version of the documentation. For instance, if you're making updates for the documentation version `7.0`, you must base your PR on the `7.0` branch.
2. **This step is crucial.** Each branch contains documentation for a specific version of Mautic. You must base your PR on the branch that corresponds to the version you are modifying. If you don't, your changes may apply to the wrong version of the documentation. For instance, if you're making updates for the documentation version `7.0`, you must base your PR on the `7.0` branch, and so on.
At the top, you should see several dropdown menus: 'base repository', 'base', 'head repository', and 'compare'.
Expand All @@ -272,9 +274,90 @@
4. Submit it for review.
> [!IMPORTANT]
>
> If you mistakenly based your PR on the wrong branch or selected the wrong branch when creating a PR, as in step 2, follow the steps in the next "[Git cherry-pick](#git-cherry-pick)" section.
#### Git cherry-pick
Say you need to update the documentation for version `7.0`. By mistake, you create a new branch from branch `6.0` and work on this branch. Or you correctly apply your changes based on branch `7.0`, but when you create the PR, you forgot to set the base branch to `7.0`.
When this happens, our maintainers will ask you to rebase your PR. You can either [rebase your PR](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase) or create a new PR and use [git cherry-pick](https://www.atlassian.com/git/tutorials/cherry-pick) to incorporate your commits as follows:

Check failure on line 285 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'rebase'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'rebase'?", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 285, "column": 84}}}, "severity": "ERROR"}

Check failure on line 285 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'rebase'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'rebase'?", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 285, "column": 52}}}, "severity": "ERROR"}

Check warning on line 285 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Will] Avoid using 'will'. Raw Output: {"message": "[Google.Will] Avoid using 'will'.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 285, "column": 36}}}, "severity": "WARNING"}

Check warning on line 285 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'our'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 285, "column": 20}}}, "severity": "WARNING"}
1. In your code editor, [create a new branch](#create-a-new-branch) and make sure that you base your new branch on the branch that you need to work on.
2. On GitHub, go to your PR and close your PR by clicking the 'Close pull request' button at the bottom.
![Close pull request button on GitHub](../assets/images/close_pr_button_github.png)
3. Click the 'Commits' tab at the top. You should see the list of your commits.
![Commits tab and list of commits on GitHub](../assets/images/commits_tab_github.png)
4. Click the copy icon next to the hash to copy the full SHA value. If you have multiple commits, start at the top and work through to the end.

Check warning on line 296 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'SHA', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'SHA', if it's unfamiliar to the audience.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 296, "column": 58}}}, "severity": "INFO"}
![Copy icon button to copy the full SHA value on GitHub](../assets/images/copy_full_sha_github.png)

Check warning on line 298 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'SHA', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'SHA', if it's unfamiliar to the audience.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 298, "column": 40}}}, "severity": "INFO"}
5. In your terminal, run this command:
```bash
git cherry-pick commit-hash
```
Change the `commit-hash` with the full SHA value that you've copied. Here's an example:

Check warning on line 306 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'SHA', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'SHA', if it's unfamiliar to the audience.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 306, "column": 43}}}, "severity": "INFO"}
```bash
git cherry-pick a1b2c3d4e5f678901234567890abcdef12345678
```
6. If there are merge conflicts, resolve them before continuing. Once you've resolved them, you need to add the file(s) to the stage phase and continue the process:

Check warning on line 312 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Stage' instead of 'stage'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Stage' instead of 'stage'.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 312, "column": 128}}}, "severity": "INFO"}

Check warning on line 312 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 312, "column": 117}}}, "severity": "INFO"}

Check failure on line 312 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'file(s)'. Raw Output: {"message": "[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'file(s)'.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 312, "column": 113}}}, "severity": "ERROR"}

```bash
git add .
git cherry-pick --continue
```

If you're using VSCode and a new tab opens to change the commit message, you can either enter a new one or close the tab to keep the original.

Check failure on line 319 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'VSCode'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'VSCode'?", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 319, "column": 20}}}, "severity": "ERROR"}
You might get prompted with the following message:
```bash
On branch BRANCH-NAME
You are currently cherry-picking commit XXXXXXX.
(all conflicts fixed: run "git cherry-pick --continue")
(use "git cherry-pick --skip" to skip this patch)
(use "git cherry-pick --abort" to cancel the cherry-pick operation)
nothing to commit, working tree clean
The previous cherry-pick is now empty, possibly due to conflict resolution.
If you wish to commit it anyway, use:
git commit --allow-empty
Otherwise, please use 'git cherry-pick --skip'
```
If the files are in the state you want them to be, and you don't need a commit in your history, use the recommended skip option:

```bash
git cherry-pick --skip
```

If you want to have a record in your history showing that you attempted to apply this specific commit, use the command Git suggests:

```bash
git commit --allow-empty
```

7. [Push your changes](#push-changes-to-the-remote-repository) to the remote repository.
8. [Create a new PR](#create-a-pr). Ensure you change the base branch to the appropriate version branch before clicking the 'Create pull request' button.

## Getting started

This project is built with [Sphinx](https://www.sphinx-doc.org/en/master/) and hosted on the [Read the Docs platform](https://readthedocs.org). The contents are written in [reStructuredText (RST)](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html).
This project is built with [Sphinx](https://www.sphinx-doc.org/en/master/) and hosted on the [Read the Docs platform](https://readthedocs.org).

Check warning on line 356 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is built'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is built').", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 356, "column": 14}}}, "severity": "INFO"}

The contents are available in the `docs/` directory and written in [reStructuredText (RST)](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html).

Check warning on line 358 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'RST', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'RST', if it's unfamiliar to the audience.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 358, "column": 87}}}, "severity": "INFO"}

Check warning on line 358 in .github/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": ".github/CONTRIBUTING.md", "range": {"start": {"line": 358, "column": 86}}}, "severity": "INFO"}

---

There are three ways to work on changes for the Mautic User Documentation:

Expand All @@ -290,11 +373,11 @@

1. Click the 'Edit on GitHub' button on the top right of the page where you noticed the mistake. It takes you to the correct resource on GitHub.

![Screenshot of community handbook with a red box highlighting the Edit on GitHub button](../assets/images/edit-on-github.png)
![Screenshot of community handbook with a red box highlighting the Edit on GitHub button](../assets/images/edit_on_github.png)

2. Click the edit button — which resembles a pencil — and make the necessary changes.

![Screenshot of community handbook with a red box highlighting the Edit on GitHub button](../assets/images/edit-button-github.png)
![Screenshot of community handbook with a red box highlighting the Edit on GitHub button](../assets/images/edit_button_github.png)

3. Follow the instructions to commit the changes.
4. Select to commit to a new branch. Call the branch something relative to what you are updating.
Expand Down Expand Up @@ -331,7 +414,7 @@

1. [Fork](#forking-the-repository) this repository to your own GitHub account.
2. Go to your forked repository on GitHub.
3. Click the branch dropdown menu on the top left and select the branch you need to base your changes on. For example, if you need to update documentation for Mautic version 7, switch to `7.0`.
3. Click the branch dropdown menu on the top left and select the branch you need to base your changes on. For example, if you need to update documentation for Mautic version 6, switch to `6.0`; for version 7, switch to `7.0`, and so on.

![Highlight branch dropdown menu on GitHub](../assets/images/switch_branch_github.png)

Expand All @@ -342,12 +425,17 @@

6. Wait until the codespace finishes building. Once it's finished, the build prompt closes, the README preview opens — you can close this preview, and the `postCreateCommand` runs. Please wait until it finishes doing its job.
![Screenshot of postCreateCommand running in terminal](../assets/images/postcreatecommand-on-terminal.png)
![Screenshot of postCreateCommand running in terminal](../assets/images/postcreatecommand_on_terminal.png)
7. [Create a new branch](#create-a-new-branch) to work on your changes.
**Info:** Once you create a new branch, it automatically switches to your new branch. If you haven't seen the branch changes in your terminal, run `git status`, and you should see your branch name.

8. All contents of the Mautic Community Handbook are available in the `docs/` directory. In your terminal, navigate to the `docs/` directory with `cd docs`.
8. Go to the `docs/` directory:

```bash
cd docs
```

9. Find the folder and file that you need to work on.
10. Work on your changes and use the [live preview](#live-preview-on-codespace) to view and test your changes in real-time.
11. Ensure that the changes you made follow Mautic's style guide by running the Vale lint. Please read the "[Working with Vale](#working-with-vale)" section to use Vale.
Expand Down Expand Up @@ -446,6 +534,8 @@
cd user-documentation
```
Replace `user-documentation` with the name of the project you provided. For example, `user-docs-5`, `user-docs-6`, `user-docs-7`, etc.
5. [Create a new branch](#create-a-new-branch) to work on your changes.
6. Start the DDEV environment with this command:
Expand Down Expand Up @@ -598,7 +688,11 @@
> - Ensure that you wrap the sentences that you'd like Vale to skip with both `.. vale off` and `.. vale on` statements, in order. Failing to do so results in Vale lint skipping the rest of the contents.
> - Don't add statements to skip lint, unless necessary. If you're uncertain, it's best not to wrap them in the statements and let the team review and provide suggestions.

<br />
## Updating contents and UI images

To update the documentation contents and Mautic user interface (UI) images, you need to install and review Mautic to ensure accuracy.

Please read the [Tester](https://contribute.mautic.org/en/latest/contributing/tester.html) page in the community handbook for complete instructions on installing Mautic.

## Credit

Expand Down
Binary file added assets/images/close_pr_button_github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/commits_tab_github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/copy_full_sha_github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading