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!
Mautic 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.
Hacktoberfest 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 going to use it year-round due to the success of Hacktoberfest.
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!
There are several ways to contribute to Mautic without writing code:
- 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.
- 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.
- 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.
- 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.
- 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.
- Contribute to Mautic’s Knowledgebase: Write helpful articles, how-to guides, or troubleshoot common issues in the Mautic Knowledgebase.
- Update existing articles: Review and update articles to ensure they reflect the latest Mautic features and best practices.
-
Sign up for Hacktoberfest
- If you're contributing during October, register for Hacktoberfest at Hacktoberfest website using your GitHub account.
-
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. Please indicate how you'd like to contribute in the form by selecting areas such as documentation, translations, design, marketing, or community support. -
Join the Mautic community
- Visit the Mautic Forum to introduce yourself and engage with the community.
- Join the Mautic Slack for real-time conversations with contributors and the Mautic team.
-
Pick your contribution type
Choose the area where you want to contribute, whether it's documentation, translation, marketing, knowledgebase or community support. -
Find an issue
Browse through the Mautic low- and no-code Issues. There are specific tags likedocumentation,design, ortranslationto help you find no-code contribution opportunities. Use the tabs to navigate between the types of tasks. -
Make Your Contribution
- Documentation: Review or improve the documentation at Mautic Documentation.
- Translations: Get involved by translating at Mautic Translations.
- Community: Help in the forums or join conversations on Mautic’s social media platforms.
-
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 thehacktoberfest-acceptedlabel. 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 this file in this repository 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 those issues are automatically counted as a contribution when they are completed and assigned to a person, so you don't need to make a PR here for those tasks.
To make a PR to have your contribution counted, follow these steps:
- Log in to GitHub with your GitHub account
- Click the Fork button at the top right of this repository
- 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
- 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)
- Go back to the Mautic low and no-code repository
- Click the button at the top of the page to make a new pull request
- Add the details about your contribution, and submit the pull request for the team to review
- Celebrate! 🥳
Please follow this process for each contribution, so that it counts for Hacktoberfest/for Mautic's contributions. The team will add the label 'hacktoberfest-accepted' for relevant contributions, which will allow you to have your contributions counted.
- 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!
- Mautic GitHub Repository
- Mautic Documentation
- Mautic Translations on Transifex
- Mautic Forum
- Mautic Slack
- Mautic GitHub Project Tasks
- Mautic Knowledgebase
- Hacktoberfest Website
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!
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.
| Your name | Link to your contribution | Notes |
|---|---|---|
| Favour Chibueze (@favour-chibueze) | #1 | Initial setup of the Hacktoberfest no-code documentation |
| Mojisola Otusheso (MojisolaaaO) | #13767 | Tested the PR |
| Rahul Shinde (shinde-rahul) | #12180 | Updated the description and recorded a testing demo |
| Mojisola Otusheso (MojisolaaaO) | #13849 | Tested the PR |
| Mojisola Otusheso (MojisolaaaO) | #13950 | Tested the PR |
| Ima-Abasi Effiong (imaabasiee) | #12180 | Tested the PR |
| Mojisola Otusheso (MojisolaaaO) | #14168 | Created an Issue (Bug) |
| Mojisola Otusheso (MojisolaaaO) | #14171 | Created a Issue (Bug) |
| Mojisola Otusheso (MojisolaaaO) | #14014 | Tested the PR |
| Rahul Shinde (shinde-rahul) | #13767 | Code review |
| Adedayo Olaoluwa (Adedayo-Olaoluwa) | #14014 | Tested the PR |
| Olaoluwa Adedayo (Adedayo-Olaoluwa) | 14013 | Tested the PR |
| Dorcas Opatola (DorcasOpatola) | #7 | Created visual to promote Mautic Conference Europe |
| Mojisola Otusheso (MojisolaaaO) | #13984 | Tested the PR |
| Ima-Abasi Effiong (imaabasiee) | #13767 | Tested the PR |
| Ima-Abasi Effiong (imaabasiee) | #13984 | Tested the PR |
| Mojisola Otusheso (MojisolaaaO) | #14117 | Tested the PR |
| Rahul Shinde (shinde-rahul) | #14193 | Code review |
| Rahul Shinde (shinde-rahul) | #13984 | Code review |
| Ashmita Majee(ASHMITA489) | #10 | Uploaded a case study |
| Toyibat Adele(Teebarh) | #8 | Created marketing content |
| Rahul Shinde (shinde-rahul) | #14201 | Code review |
| Mojisola Otusheso (MojisolaaaO) | #14200 | Tested the PR |
| Ashmita Majee(ASHMITA489) | #49 | Uploaded a case study |
| Raffy Rodriguez (RaffyRod) | #14155 | Tested the PR |
| Raffy Rodriguez (RaffyRod) | #14193 | Tested the PR |
| Raffy Rodriguez (RaffyRod) | #14201 | Tested the PR |
| Raffy Rodriguez (RaffyRod) | #14204 | Code review |
| Laurie Lim (laurielim) | #13927 | Tested the PR |
| Mojisola Otusheso (MojisolaaaO) | #13927 | Tested the PR |
| Dorcas Opatola (DorcasOpatola) | #9 | Created layouts for transactional emails for Mautic Conference Lisbon |
| Rahul Shinde (shinde-rahul) | #12899 | Code review and user testing |
| Rahul Shinde (shinde-rahul) | #14218 | Code review and user testing |
| Laurie Lim (laurielim) | #63 | Translated kb UI to French |
| Laurie Lim (laurielim) | #74 | Translated kb categories to French |
| Mojisola Otusheso (MojisolaaaO) | #14201 | Tested the PR |
| Dorcas Opatola (DorcasOpatola) | #71 | Designed Images for MautiCon Lisbon |
| Laurie Lim (laurielim) | #75 | Translated kb article 'How to Grow your Community with Mautic' to French |
| Ayu Adiati (@adiati98) | #25 | Updated the content on the communication channels page |
| Dorcas Opatola (DorcasOpatola) | #80 | Membership Flyer Design For MautiCon Lisbon |
| Rahul Shinde (shinde-rahul) | #14215 | Code review |
| Rahul Shinde (shinde-rahul) | #14214 | Code review |
| Rahul Shinde (shinde-rahul) | #14191 | User testing |
| Markus Heinilä (markusvjh) | #64 | New Blogpost, formatting and aligning with CSS |
| Your name | Link to your contribution | Notes |
|---|---|---|
| Ruth Cheesley | #93 | Update repo for ongoing use |