Skip to content

How Can You Contribute?ยถ

A direct contribution to the MASVS or the MASTG can be done in many different ways. First of all Create a GitHub account (a free one is enough) by following these steps.

Contribution Flowยถ

flowchart LR
    A(Open Discussion) -->|discuss| C{qualifies?}
    C -->|Yes| D(Issue)
    C -->|No| E[Close]
    D -->|open PR| F(Pull Request)
    F -->|review| G{approved?}
    F -->|make changes| F
    G -->|Yes| H[Merge]
    G -->|No| I[Close]

๐Ÿ’ฌ Participate in Discussionsยถ

Our GitHub Discussions are the first place to go for asking questions, giving us feedback and proposing new ideas. If your proposal qualifies for the MASTG/MASVS we'll convert it into an "Issue" (the discussion might take a while).

๐ŸŽฏ Create Issuesยถ

You can create Issues first for missing requirements, content or errors so that it can be discussed before creating a PR.

  • In order to avoid conflicts that several people are working on the same issue without knowing it, the issue will be assigned to one or more people by the project leaders.
  • Explain what you think is missing in the issue, including references (if available) and give a suggestion as to where it could be added.

๐Ÿ“ Open a Pull Requestยถ

You can contribute with content or corrections by opening a Pull Request (PR).

  • Your PR may be merged after review.
  • Be sure to follow our style guide when writing content.

Learn how to open a PR here.

โœ… Become a Reviewerยถ

You can Review Pull Requests (PRs) and also gain contributions. If you are a fluent speaker in any of the different languages that the MASVS is available in, feel free to give feedback on any of the submitted PRs.

After your PR or issue has been submitted, we will review it as quickly as possible which typically only takes a few days. If you think we have forgotten about it, feel free to give us a nudge after 7 days have passed.

Learn how to review a PR here.

๐Ÿ”Ž Proof-readingยถ

If you do proof-reading, these are the things weโ€™re looking for:

  • Content cohesion & coherence
    • is there a good linkage of ideas?
    • does the paragraph make sense?
    • does it make sense with the next one? think that hundreds of people have written in here, often without considering the surroundings of the text they were including).
  • Reducing the content to a minimum (people tend to be very verbose/wordy) and in such a document we need clear and short/concise statements
  • Optimize for scannability (maybe instead of a big paragraph it would be better to have a bullet point list).
  • Any passive voice sentences? Convert to active voice.
  • Does each paragraph focus on a single topic?
  • Are key points stated at the start of each section?
  • Are commas, parentheses, colons, em-dashes, and semicolons used properly?

Refer to Google Technical Writing trainings for more info:

๐ŸŒ Translating the MASVSยถ

Translating the MASVS in a new language is another great way to contribute. This helps the project to reach to more people around the world.

Before starting a translation please consider the following:

  • First of all contact us on Slack or via email.
  • We need your commitment. After the first translation is done, we will ask for your help to translate any new changes, so your translation can remain up to date.
  • We need a second translator who can verify that the English version of the MASVS has been translated properly.
  • Once you are all set, go to your fork and follow these steps.