Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (37 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

69 lines (37 loc) · 3.86 KB

Contributing to Mautic user documentation

Contributions are always welcome, no matter how large or small, or at whatever skill level you are. Before contributing, please read the Code of Conduct and follow the directions in this guide.

Table of contents

Communication expectation

  • Communicate in the GitHub repository first before Slack. Whether it's in the issue or the PR, keeping the lines of communication open and visible to everyone on the team helps everyone around you.

  • Please don't DM maintainers on Slack to review or ask feedback and questions about your PR.

    If you'd like feedback or have questions about your PR, tag @mautic/education-team-leaders in the PR's comments or use the #t-education channel on Slack. That way, not only maintainers, but the community can help you get unstuck. The team always receives a notification on new PR creation. If you haven't received a review within a week, you can tag them in the PR comments to ask for an estimated review time.

Issues

  • When you contribute to the project for the first time, please consider checking the good first issue or help wanted labels.

  • If you want to work on an open issue, please comment on it so a maintainer can assign it to you.

    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.

  • Don’t ask maintainers to assign you to another issue before you finish working on your current one and create a PR. Also, avoid requesting assignment to an issue that already has someone assigned. However, if the assignee hasn’t addressed the issue for a while and you’re interested in working on it, leave a comment to ask about its status and progress.

  • Did you spot a typo, missing instructions, or have an idea for enhancing the Mautic user documentation? You can create an issue to address it.

    However, the Education Team needs to triage the issue before you can work on it. If you wish to work on the issue you submitted, please inform and tag the @mautic/education-team-leaders in the comment.

Pull requests

  • Ensure that a maintainer assigns you to an existing issue, and always link your work to the issue in your PR.

  • Ensure that you address one issue in one PR. If you work on multiple issues, work on them separately and create a single PR for each.

  • Always leave a detailed description in the PR. Leave nothing ambiguous for the reviewers.

  • Provide screenshots or screen recordings for visual changes.

  • Always review your code first. Be sure to run the project locally and test it thoroughly before requesting a review. This includes ensuring that the content renders correctly in the front-end, and checking Vale for any grammatical fixes.

Getting started

Please refer to the "Contributing to Mautic’s documentation" page in the Mautic community handbook for detailed instructions on how to contribute to this repository.

Credit

Mautic adapted these contributing guidelines from the OpenSource-Communities/intro repository.

Thank you for contributing to the improvement of the Mautic user documentation.