Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create 2025.md #111

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
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
147 changes: 147 additions & 0 deletions 2025.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
# Low- and no-code guide for contributing to Mautic
RCheesley marked this conversation as resolved.
Show resolved Hide resolved

Welcome to **Mautic**! We're excited that you're interested in contributing to **Mautic**, an open source marketing automation platform. Contributions come in many forms, and not all of them require coding skills. This guide will show you how to contribute to Mautic without writing a single line of code!

## Table of Contents

- [About Mautic](#about-mautic)
- [What is Hacktoberfest?](#what-is-hacktoberfest)
- [Why Low- and No-Code Contributions Matter](#why-low-and-no-code-contributions-matter)
- [Ways to Contribute](#ways-to-contribute)
- [1. **Documentation**](#1-documentation)
- [2. **Translations**](#2-translations)
- [3. **Community Engagement**](#3-community-engagement)
- [4. **Design and User Experience (UX)**](#4-design-and-user-experience-ux)
- [5. **Marketing**](#5-marketing)
- [6. **Knowledgebase**](#6-knowledgebase)
- [How to Get Started](#how-to-get-started)
- [Useful Resources](#useful-resources)
Comment on lines +9 to +18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Do we want to include the section headers in line 133-147 in the TOC?

suggestion: Because Mautic uses "sentence' style for titles, let's fix the capitalization here, too. :)

Suggested change
- [Why Low- and No-Code Contributions Matter](#why-low-and-no-code-contributions-matter)
- [Ways to Contribute](#ways-to-contribute)
- [1. **Documentation**](#1-documentation)
- [2. **Translations**](#2-translations)
- [3. **Community Engagement**](#3-community-engagement)
- [4. **Design and User Experience (UX)**](#4-design-and-user-experience-ux)
- [5. **Marketing**](#5-marketing)
- [6. **Knowledgebase**](#6-knowledgebase)
- [How to Get Started](#how-to-get-started)
- [Useful Resources](#useful-resources)
- [Why low- and no-code contributions matter](#why-low-and-no-code-contributions-matter)
- [Ways to contribute](#ways-to-contribute)
- [1. **Documentation**](#1-documentation)
- [2. **Translations**](#2-translations)
- [3. **Community engagement**](#3-community-engagement)
- [4. **Design and user experience (UX)**](#4-design-and-user-experience-ux)
- [5. **Marketing**](#5-marketing)
- [6. **Knowledgebase**](#6-knowledgebase)
- [How to get started](#how-to-get-started)
- [Useful resources](#useful-resources)


---

## About Mautic

[Mautic](https://www.mautic.org/) is the world’s largest open source marketing automation project. With over 200,000 organisations using Mautic and over 1,000 community volunteers, we empower businesses by making it easy to manage their marketing across a range of channels.

## What is Hacktoberfest?

[Hacktoberfest](https://hacktoberfest.com/) is an annual event encouraging contributions to open source projects. Throughout October, participants are invited to submit contributions to open source repositories like Mautic. Contributions can be code, documentation, design, translations, or community support. This repository was initially created to support the Hacktoberfest event but we're now using it year-round due to the success of Hacktoberfest.

## Why low- and no-code contributions matter
RCheesley marked this conversation as resolved.
Show resolved Hide resolved

Open source projects thrive not only from code contributions but also from the community's efforts in other areas. Low- and no-code contributions help Mautic grow and improve through better documentation, translations, community support, and more. If you're not a developer but want to contribute to open source, there are plenty of ways to get involved!

## Ways to Contribute
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Ways to Contribute
## Ways to contribute


There are several ways to contribute to Mautic without writing code:

### 1. **Documentation**

- **Improve or create new documentation**: Help by editing existing documentation for clarity, or writing new guides, tutorials, and FAQs.
- **Review documentation**: Proofread and provide feedback to ensure accuracy and readability.

### 2. **Translations**

- **Translate Mautic**: Assist in translating Mautic’s user interface, documentation, or tutorials into different languages.
- **Proofread translations**: Review existing translations and help refine them for correctness and localization.

### 3. **Community engagement**

- **Answer questions**: Help users in Mautic’s forums, Slack, or other community platforms by answering questions or sharing your experiences.
- **Organize or participate in events**: Organize local Mautic meetups, workshops, or help promote Mautic in your community.

### 4. **Design and user experience (UX)**

- **Create or improve UI/UX designs**: Work on wireframes, mockups, and designs that improve the user interface of Mautic.
- **Usability testing**: Provide feedback on how Mautic can be more user-friendly by testing features and sharing your insights.

### 5. **Marketing**

- **Promote Mautic**: Spread the word about Mautic through social media, blogs, or video tutorials.
- **Create content**: Write articles, create videos, or design infographics that explain Mautic’s features and benefits.

### 6. **Knowledgebase**

- **Contribute to Mautic’s Knowledgebase**: Write helpful articles, how-to guides, or troubleshoot common issues in the [Mautic Knowledgebase](https://kb.mautic.org/).
- **Update existing articles**: Review and update articles to ensure they reflect the latest Mautic features and best practices.

## How to Get Started
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## How to Get Started
## How to get started


1. **Sign up for Hacktoberfest, if you're participating**

If you're contributing during October, register for Hacktoberfest at [Hacktoberfest website](https://hacktoberfest.com/auth/) using your GitHub account.

2. **Sign up to contribute to Mautic**

If you're contributing during October, register to participate in Mautic's Hacktoberfest event by filling out the form here: [Mautic Hacktoberfest 2024 Signup](https://m.mautic.org/hacktoberfest-24-signup). Please indicate **how you'd like to contribute** in the form by selecting areas such as documentation, translations, design, marketing, or community support.

3. **Join the Mautic community**
- Visit the [Mautic Forum](https://forum.mautic.org/) to introduce yourself and engage with the community.
- Join the [Mautic Slack](https://www.mautic.org/slack) for real-time conversations with contributors and the Mautic team.

4. **Pick your contribution type**

Choose the area where you want to contribute, whether it's documentation, translation, marketing, knowledgebase or community support.

5. **Find an issue**

Browse through the **[Mautic Low- and No-Code Issues](https://github.com/orgs/mautic/projects/21/)**. There are specific tags like `documentation`, `design`, or `translation` to help you find no-code contribution opportunities. Use the tabs to navigate between the types of tasks.

6. **Make Your Contribution**
Copy link
Contributor

@adiati98 adiati98 Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: We might want to fix the capitalization here for consistency.

Suggested change
6. **Make Your Contribution**
6. **Make your contribution**

- **Documentation**: Review or improve the documentation at [Mautic Documentation](https://docs.mautic.org/).
- **Translations**: Get involved by translating at [Mautic Translations](https://www.transifex.com/mautic/mautic/).
- **Community**: Help in the forums or join conversations on Mautic’s social media platforms.

7. **Submit Your Contribution**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
7. **Submit Your Contribution**
7. **Submit your contribution**


For documentation, submit your work via a pull request on GitHub. If you're contributing in October, make sure to reference Hacktoberfest in your contribution notes so that the team know to add the `hacktoberfest-accepted` label. For other tasks like translations or writing on the knowledgebase, follow the submission process on Transifex or the knowledgebase and then follow the steps below to have your contribution validated and counted.

For low- and no-code contributions where there is no pull request to make (e.g. marketing, design etc.), we've created a file in this repository (named YYYY.md, for example 2025.md) where we will maintain an activity log, which will allow you to submit a pull request (so that it counts for Hacktoberfest and as a Mautic contribution) each time you complete a task. **Please note:** Some teams work on Jira, and the issues there are automatically counted as a contribution when they are completed and assigned to a person. If you work with issues on Jira, you don't need to make a PR here for those tasks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestions: I see around (also on GitHub docs) that file names are commonly wrapped in backticks. It's your call whether to wrap the file names here in backticks or not.

Suggested change
For low- and no-code contributions where there is no pull request to make (e.g. marketing, design etc.), we've created a file in this repository (named YYYY.md, for example 2025.md) where we will maintain an activity log, which will allow you to submit a pull request (so that it counts for Hacktoberfest and as a Mautic contribution) each time you complete a task. **Please note:** Some teams work on Jira, and the issues there are automatically counted as a contribution when they are completed and assigned to a person. If you work with issues on Jira, you don't need to make a PR here for those tasks.
For low- and no-code contributions where there is no pull request to make (e.g. marketing, design etc.), we've created a file in this repository (named `YYYY.md`, for example `2025.md`) where we will maintain an activity log, which will allow you to submit a pull request (so that it counts for Hacktoberfest and as a Mautic contribution) each time you complete a task. **Please note:** Some teams work on Jira, and the issues there are automatically counted as a contribution when they are completed and assigned to a person. If you work with issues on Jira, you don't need to make a PR here for those tasks.


To make a PR to have your contribution counted, follow these steps:

1. Log in to GitHub with your GitHub account
2. Click the Fork button at the top right of this repository
3. Edit the relevant file for the current year, and add your contribution and a link to the issue at the bottom of the list. Follow any instructions that are written as to the formatting to use
4. Click the button to commit your changes, and make a new branch (ideally call it something relevant to this contribution, so you know what each one is)
5. Go back to the [Mautic low and no-code](https://github.com/mautic/low-no-code) repository
6. Click the button at the top of the page to make a new pull request
7. Add the details about your contribution, and submit the pull request for the team to review
8. Celebrate! 🥳

Please follow this process for each contribution, so that it counts for Hacktoberfest or Mautic's contributions. The team will add the label `hacktoberfest-accepted` for relevant contributions, which will allow you to have your contributions counted.
Comment on lines +101 to +112
Copy link
Contributor

@adiati98 adiati98 Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestions: (Sorry I totally missed this!)

Because these are part of number 7, we want to give indentation. However, there is one problem. The list for the steps will be in roman numerals because they are nested. Another way is to use unordered list here if you'd like.

Suggested change
To make a PR to have your contribution counted, follow these steps:
1. Log in to GitHub with your GitHub account
2. Click the Fork button at the top right of this repository
3. Edit the relevant file for the current year, and add your contribution and a link to the issue at the bottom of the list. Follow any instructions that are written as to the formatting to use
4. Click the button to commit your changes, and make a new branch (ideally call it something relevant to this contribution, so you know what each one is)
5. Go back to the [Mautic low and no-code](https://github.com/mautic/low-no-code) repository
6. Click the button at the top of the page to make a new pull request
7. Add the details about your contribution, and submit the pull request for the team to review
8. Celebrate! 🥳
Please follow this process for each contribution, so that it counts for Hacktoberfest or Mautic's contributions. The team will add the label `hacktoberfest-accepted` for relevant contributions, which will allow you to have your contributions counted.
To make a PR to have your contribution counted, follow these steps:
1. Log in to GitHub with your GitHub account
2. Click the Fork button at the top right of this repository
3. Edit the relevant file for the current year, and add your contribution and a link to the issue at the bottom of the list. Follow any instructions that are written as to the formatting to use
4. Click the button to commit your changes, and make a new branch (ideally call it something relevant to this contribution, so you know what each one is)
5. Go back to the [Mautic low and no-code](https://github.com/mautic/low-no-code) repository
6. Click the button at the top of the page to make a new pull request
7. Add the details about your contribution, and submit the pull request for the team to review
8. Celebrate! 🥳
Please follow this process for each contribution, so that it counts for Hacktoberfest or Mautic's contributions. The team will add the label `hacktoberfest-accepted` for relevant contributions, which will allow you to have your contributions counted.


8. **Get Your Rewards**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
8. **Get Your Rewards**
8. **Get your rewards**


After contributing to four eligible open source repositories during Hacktoberfest, you’ll earn a limited-edition Mautic Hacktoberfest digital badges. For other contributions, we're working on unique Holopin badges - watch this space!

## Useful Resources

- [Mautic GitHub Repository](https://github.com/mautic/mautic)
- [Mautic Documentation](https://docs.mautic.org/)
- [Mautic Translations on Transifex](https://www.transifex.com/mautic/mautic/)
- [Mautic Forum](https://forum.mautic.org/)
- [Mautic Slack](https://www.mautic.org/slack)
- [Mautic GitHub Project Tasks](https://github.com/orgs/mautic/projects/21/views/1)
- [Mautic Knowledgebase](https://kb.mautic.org/)
- [Hacktoberfest Website](https://hacktoberfest.com/)

---

Thank you for being part of the Mautic community and for your contributions throughout 2024. Every contribution helps make Mautic better for users around the world!

## 2025

### Hacktoberfest no-code contribution activity log
RCheesley marked this conversation as resolved.
Show resolved Hide resolved

When linking to your contribution, please write a descriptive title and use the full link of the Jira issue, Knowledgebase article, or other reference. For example, [Article on how to contribute to the Knowledgebase](https://kb.mautic.org/article/how-to-contribute-to-the-knowledge-base.html).

| Your name | Link to your contribution | Notes |
|-------------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------|
| Ruth Cheesley (@rcheesley) | [https://github.com/mautic/low-no-code/pull/111 ](https://github.com/mautic/low-no-code/pull/111) | Initial setup of the Hacktoberfest no-code documentation |

### Ongoing contributions

| Your name | Link to your contribution | Notes |
|-------------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------|
| Ruth Cheesley | [https://github.com/mautic/low-no-code/pull/111](https://github.com/mautic/low-no-code/pull/111) | Update repo for ongoing use |