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 Mautic style guide #3

Open
4 tasks
fakela opened this issue Jan 3, 2022 · 3 comments
Open
4 tasks

Create Mautic style guide #3

fakela opened this issue Jan 3, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone

Comments

@fakela
Copy link
Member

fakela commented Jan 3, 2022

Add the documentation on ways a contributor can contribute to Mautic

  • add screenshots where necessary

  • proofread the documentation

  • make changes where necessary

  • add additional information that would be useful

From the old documentation https://docs.mautic.org/en/contributing/style-guide


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@fakela fakela added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 3, 2022
@fakela fakela added this to the V1.0 milestone Jan 3, 2022
@fgonzalez
Copy link

I want to help,
how can i do it?

@fakela
Copy link
Member Author

fakela commented May 9, 2023

Hi @fgonzalez, the scope of what we want to cover is how to work with Vale and the RST Checker, how to use Gitpod, and the tools that you can use for VSCode / PHPStorm, etc to help you lint as you work.

we have this style guide: https://contribute.mautic.org/education-team/technical-writing-styleguide but it's lacking these information

cc: @RCheesley

@RCheesley
Copy link
Sponsor Member

@fgonzalez do you need some assistance to get started? Happy to help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants