Docs: Add contributing guidelines to branch 7.0 #546
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adiati98
requested review from
RCheesley and
favour-chibueze
and removed request for
a team
RCheesley
requested changes
Dec 3, 2025
Member
RCheesley
left a comment
RCheesley
left a comment
There was a problem hiding this comment.
Cracking job, a few suggestions for you - no rush! 🎅🏻
| - [Git cherry-pick](#git-cherry-pick) | ||
| - [Getting started](#getting-started) | ||
| - [1. On GitHub](#1-on-github) | ||
| - [2. GitHub Codespaces](#2-github-codespaces) |
Member
There was a problem hiding this comment.
Let's add to the accept.txt list.
|
|
||
| - When you contribute to the project for the first time, please consider checking the [good first issue](https://github.com/mautic/user-documentation/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) or [help wanted](https://github.com/mautic/user-documentation/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) labels. | ||
|
|
||
| - If you wish to work on an open issue, please comment on the issue, and a maintainer will assign it to you. |
Member
There was a problem hiding this comment.
Suggested change
| - If you wish to work on an open issue, please comment on the issue, and a maintainer will assign it to you. | |
| - If you wish to work on an open issue, please comment on the issue, and wait to be assigned by a maintainer. |
|
|
||
| If an issue isn't assigned, it's assumed to be available for anyone to work on. So, ensure that you're assigned to an issue **before** beginning work to avoid conflicts. | ||
|
|
||
| **Note:** Please don't ask maintainers to assign you to another issue before you have finished working on yours and created a PR. |
Member
There was a problem hiding this comment.
Let's use the note admonition here.
Suggested change
| **Note:** Please don't ask maintainers to assign you to another issue before you have finished working on yours and created a PR. | |
| **Note:** please don't ask maintainers to assign you to another issue before you have finished working on yours and created a PR. |
|
|
||
| **Note:** Please don't ask maintainers to assign you to another issue before you have finished working on yours and created a PR. | ||
|
|
||
| - Please don't ask maintainers to assign you to an issue that already has someone assigned to it. If the assigned issue hasn't been addressed for a while and you're interested in working on it, leave a comment on the issue to ask about its status and progress. |
Member
There was a problem hiding this comment.
Suggested change
| - Please don't ask maintainers to assign you to an issue that already has someone assigned to it. If the assigned issue hasn't been addressed for a while and you're interested in working on it, leave a comment on the issue to ask about its status and progress. | |
| - Please don't ask maintainers to assign you to an issue that already has someone assigned to it. If the assigned issue isn't resolved and it's been while, if you're interested in working on it, leave a comment on the issue to ask about its status and progress. |
|
|
||
| ## Pull requests (PRs) | ||
|
|
||
| PRs are always welcome. However, before working on changes, you must ensure that **you are assigned** to an existing issue and **link your work to the issue in your PR**. |
Member
There was a problem hiding this comment.
Suggested change
| PRs are always welcome. However, before working on changes, you must ensure that **you are assigned** to an existing issue and **link your work to the issue in your PR**. | |
| PRs are always welcome. However, before working on changes, you must ensure that **a maintainer has assigned you** to an existing issue and **link your work to the issue in your PR**. |
|
|
||
|  | ||
|
|
||
| 3. Uncheck the option of 'Copy the DEFAULT-BRANCH-NAME branch only' because later on, you want to be able to clone multiple branches. |
Member
There was a problem hiding this comment.
Suggested change
| 3. Uncheck the option of 'Copy the DEFAULT-BRANCH-NAME branch only' because later on, you want to be able to clone multiple branches. | |
| 3. Remove the check in the option of 'Copy the DEFAULT-BRANCH-NAME branch only' because later on, you want to be able to clone multiple branches. |
|
|
||
| 4. Click the green 'Create fork' button at the bottom. | ||
|
|
||
|  |
Member
There was a problem hiding this comment.
Suggested change
|  | |
|  |
|
|
||
| 3. Open your forked user-documentation repository. The URL should have your username. For example: `https://github.com/YOUR-GITHUB-USERNAME/user-documentation`. | ||
| 4. Click the green 'Code' button on top. | ||
| 5. Select 'HTTPS' and copy the URL. |
Member
There was a problem hiding this comment.
Probs needs adding to accept.txt.
|
|
||
| ### Create a new branch | ||
|
|
||
| Before making changes, ensure that you create a new branch and work on it. You don't want to directly work on the default — such as `main` — or any other base branch, because you won't be able to work on lots of things at the same time. If you make all those changes on one branch, it's not possible to separate them out and only merge one change at a time. |
Member
There was a problem hiding this comment.
Suggested change
| Before making changes, ensure that you create a new branch and work on it. You don't want to directly work on the default — such as `main` — or any other base branch, because you won't be able to work on lots of things at the same time. If you make all those changes on one branch, it's not possible to separate them out and only merge one change at a time. | |
| Before making changes, ensure that you create a new branch and work on it. You don't want to directly work on the default - such as `main` - or any other base branch, because you won't be able to work on lots of things at the same time. If you make all those changes on one branch, it's not possible to separate them out and only merge one change at a time. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds contributing guidelines to the branch
7.0. It follows the contributing guidelines in the default branch with some tweaks and an addition:"Clone the repository" section in this PR only contains how to clone branch
7.0instead of all current branches (5.2,6.0, and7.0)Add a new section, "Updating contents and UI images", for instructions to read the Tester page in the community handbook to install Mautic for updating the user documentation.
Linked issue
Closes #545
Screenshots or screen recordings
New section