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
155 changes: 155 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# Contributing to Mautic low- and no-code

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)
- [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 organizations 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 that encourages contributions to open source projects. Throughout October, they invite participants to submit contributions to open source repositories such as Mautic. Contributions can be code, documentation, design, translations, or community support.

> [!NOTE]
> Mautic created this repository for Hacktoberfest, but now utilizes it year-round because of its success.

## Why low- and no-code contributions matter

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

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

### 1. Sign up for Hacktoberfest - Hacktoberfest participants only

If you're contributing in October and want to participate in Hacktoberfest, register for the event on the [Hacktoberfest website](https://hacktoberfest.com/auth/) using your GitHub account.

### 2. Sign up for Mautic Hacktoberfest - Hacktoberfest participants only

If you're taking part in Hacktoberfest, register for Mautic's Hacktoberfest event by filling out the [Mautic Hacktoberfest Signup](https://m.mautic.org/hacktoberfest-signup) form. Indicate **how you'd like to contribute** by selecting areas of interest in the form.

### 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, or something else.

See the [Ways to contribute](#ways-to-contribute) section for more information.

### 5. Find an issue

Browse through the **[Mautic low- and no-code GitHub project tasks](https://github.com/orgs/mautic/projects/21/)** to find an issue to work on. Use the tabs to navigate between task types.

Some teams track tasks on Jira. Check with the relevant team lead in Slack to find out more.

### 6. Make your contribution

Start to work on your contribution.

### 7. Submit your contribution

For documentation, submit your work via a pull request - PR - on GitHub.

For low- and no-code contributions - including tasks on Jira, marketing, design, and more - there is no automatic PR to submit. To ensure these officially count for Hacktoberfest, add each of your completed tasks to the current year file in this repository, named `YYYY.md`, via a PR.

Watch the [short tutorial on YouTube](https://www.youtube.com/watch?v=jP-7LEyNo_k) to learn how to make a PR in this repository, or follow the steps below:

1. Log in to GitHub with your GitHub account.
2. Go to the main page of the [mautic/low-no-code](https://github.com/mautic/low-no-code) repository.
3. Click the **Fork** button at the top right and select your personal account in the **Owner** dropdown menu.
4. In your forked repository, open the file for the current year, named `YYYY.md`.
5. Click the **Edit this file** button at the top, which resembles a pencil icon, and add your contribution. Follow the specific instructions in the [Add a contribution to the log](#add-a-contribution-to-the-log) section below.
6. Click the button to commit your changes and make a new branch. Name your branch after your contribution. For example, `review-pr-440-community-handbook`, `marketing/update-communication-channels-page`, etc.
7. Go back to the [mautic/low-no-code](https://github.com/mautic/low-no-code) repository.
8. Click the button at the top of the page to make a new PR.
9. Add the details about your contribution and submit the PR for the team to review.

> [!NOTE]
> Complete this process for each contribution to ensure it counts towards Hacktoberfest or Mautic's contributions.

#### Add a contribution to the log

Follow the instructions below to add your contribution to the `YYYY.md` file:

1. Add your contribution to the bottom of the list. You can copy and paste the most recent list item and modify the contribution details with your own.
2. Write descriptive notes and include the full link to the GitHub issue, PR, knowledgebase article, or any other reference to link your contributions.
3. For any Jira tasks, link to the final result - such as a Mautic blog post, a social media update, or a public design file - so the team can verify your work.

Here's an example of how to format your entry:

```markdown
| 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 |
| Ayu Adiati (@adiati98) | [https://github.com/mautic/low-no-code/pull/111](https://github.com/mautic/low-no-code/pull/111) | Review PR: "Create 2025.md" |
| Joey Keller (@jos0405) | [https://github.com/mautic/mautic/pull/15501](https://github.com/mautic/mautic/pull/15501) | Test Feature/segment last built display |
| Ayu Adiati (@adiati98) | [https://mautic.atlassian.net/browse/WR-173](https://mautic.atlassian.net/browse/WR-173) | Update the content for Communication channels |
| Ruth Cheesley (@rcheesley) | [How to contribute to the Knowledge Base](https://kb.mautic.org/article/how-to-contribute-to-the-knowledge-base.html) | Article on how to contribute to the Knowledgebase |
```

### 8. Get your rewards - Hacktoberfest participants only

After contributing **six** eligible PRs during Hacktoberfest, you should earn limited-edition Mautic Hacktoberfest digital badges. For other contributions, the team is working on unique Holopin badges - watch this space.

## Useful resources

- [Mautic GitHub repository](https://github.com/mautic/mautic)
- [Mautic user documentation](https://docs.mautic.org/)
- [Mautic developer documentation](https://devdocs.mautic.org/)
- [Mautic low- and no-code GitHub project tasks](https://github.com/orgs/mautic/projects/21/views/1)
- [Mautic knowledgebase](https://kb.mautic.org/)
- [Mautic translations on Transifex](https://explore.transifex.com/mautic/mautic/)
- [Mautic forum](https://forum.mautic.org/)
- [Mautic Slack](https://www.mautic.org/slack)
- [Hacktoberfest website](https://hacktoberfest.com/)

---

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