Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/01_documentation_fix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: 📝 Documentation Fix
description: Point out an error or suggest a change in the documentation.
title: "[DOCS]:"
labels: ["documentation", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for helping improve the Mautic Developer Documentation! Please fill out the details below so we can fix it.

- type: textarea
id: description
attributes:
label: Description
description: Please describe what is inaccurate, missing, or confusing in the documentation.
placeholder: "e.g., The example code on page X is out of date and no longer works."
validations:
required: true

- type: textarea
id: doc-link
attributes:
label: Relevant Documentation URL
description: Please provide a link to the exact documentation page that needs to be updated.
placeholder: "e.g., https://devdocs.mautic.org/page-to-fix"

- type: dropdown
id: willingness-to-pr
attributes:
label: Are you willing to help us fix this by making a pull request?
description: Contributing a pull request is the fastest way to get this fixed.
options:
- "— Select an option —"
- "No"
- "Yes"
- "Yes, but I need help"
validations:
required: true

- type: textarea
id: suggestions
attributes:
label: Suggestions (Optional)
description: How do you suggest the documentation could be fixed or improved?
placeholder: "e.g., I think changing the example code to this would solve the issue..."

- type: textarea
id: screenshots
attributes:
label: Screenshots or Screen Recordings (Optional)
description: To help us understand the issue visually, please attach any relevant images or recordings.
placeholder: "Drag and drop the files here."
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: 🌱 Feature Request
description: Request a new feature or enhancement.
title: "[FEAT]:"
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature for the Mautic Developer Documentation! Please fill out the details below to help us understand and prioritize it.

- type: textarea
id: description
attributes:
label: Description
description: Please provide a clear and concise description of the feature you would like to see.
placeholder: "e.g., I'd like to be able to edit the documentation directly on GitHub. This would be useful because..."
validations:
required: true

- type: dropdown
id: willingness-to-pr
attributes:
label: Are you willing to help us add this feature this by making a pull request?
description: Contributing a pull request is the fastest way to get this fixed.
options:
- "— Select an option —"
- "No"
- "Yes"
- "Yes, but I need help"
validations:
required: true

- type: textarea
id: suggestions
attributes:
label: Suggestions (Optional)
description: How do you suggest this feature should be implemented?
placeholder: "e.g., A user could click the edit button on the documentation page to make changes."
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/03_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: 🐛 Technical Bug Report
description: Did you find a bug with the documentation system or automations? Create a report to help us improve.
title: "[BUG]:"
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a technical bug within the Mautic Developer Documentation! Please fill out the details below to help us understand and resolve it.

- type: textarea
id: description
attributes:
label: Description
description: Provide a clear and concise description of the bug. Include steps to reproduce the behavior, the expected result, and the actual result.
placeholder: "e.g., Running make html command didn't build the docs. Steps to reproduce: 1. Go to the /docs directory. 2. Run make html command. 3. Nothing happens."
validations:
required: true

- type: dropdown
id: willingness-to-pr
attributes:
label: Are you willing to help us fix this by making a pull request?
description: Contributing a pull request is the fastest way to get this fixed.
options:
- "— Select an option —"
- "No"
- "Yes"
- "Yes, but I need help"
validations:
required: true

- type: textarea
id: suggestions
attributes:
label: Suggestions (Optional)
description: How do you suggest this bug could be fixed?
placeholder: "e.g., I think changing X to Y would solve the issue."

- type: textarea
id: environment
attributes:
label: Environment
description: |
Please provide details about your environment where the bug occurred.
- OS/Platform
- Browser & Version
placeholder: "e.g., Windows 11, Chrome v125"

- type: textarea
id: screenshots
attributes:
label: Screenshots or Screen Recordings (Optional)
description: To help us understand the issue visually, please attach any relevant images or recordings.
placeholder: "Drag and drop the files here."
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: Mautic Community Support
url: https://forum.mautic.org/
about: Please ask questions around Mautic product here.
- name: Report a bug for the Mautic product
url: https://github.com/mautic/mautic/issues
about: Please create an issue to report a bug in the Mautic product here.
37 changes: 37 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Description


<!-- PLEASE WRITE ABOVE THIS COMMENT. -->

<!--

Clearly describe what changes you have made in this PR, where our maintainers or reviewers should look at, and how to test the changes.

If the request is not complete but you want feedback or have quetions, you can select the "Draft Pull Request" option from the dropdown menu when creating the PR, then ask your questions or write your feedback in the comment.

-->

## Linked issue


<!-- PLEASE WRITE ABOVE THIS COMMENT. -->

<!--

If your PR is related to a current issue, please link to that issue number. Type the keyword "Closes" followed by a hashtag (#) symbol and the issue number that you can find right after the issue title. Don't add anything else, such as period, comma, etc, to this. For example:

❌ Closes: #123.

✅ Closes #123

Doing so will automatically close the issue when one of our maintainers merges your PR.

-->

## Screenshots or screen recordings

<!--

Provide screenshots or screen recordings before and after the changes, if it's a UI changes. You can simply drag and drop your files above this comment.

-->
Loading