GitHub best practices for MDN

This page contains best practices for working with GitHub to contribute to MDN, mainly centered around how to work with issues.

When choosing a GitHub issue to work on

  1. Write a comment in the issue saying that you would like to take it on, and we'll assign you to it.
    • If someone else is already assigned to the issue:
      1. If this was more than one week ago, and there has not been much activity, @mention them and ask them if you can take it over, or otherwise help get it to completion.
        • If they agree for you to take it, we'll assign you to it and remove them.
        • If they agree for you to take it and some work has been done already, or the agreement is to help them out with it, we'll assign you to it alongside them.
      2. If it was less than one week ago, then have some patience, and give them a chance to work on it.
  2. If the issue has been marked as complete but needing a review, and you want to review it, @mention them in the comments and say you’ll review it.

When you've been assigned to an issue

  1. Scope out the remainder of the work that needs to be done.
    • If the issue is well-described, and the work is pretty obvious, go ahead and do it.
    • If the issue is not well-described, and/or you are not sure what is needed, feel free to @mention the poster and ask for more information.
    • If you are not still sure who to ask, ask for help in the MDN Web Docs chat room on Matrix.
  2. Once you think you’ve fixed an issue, ask for a review in the comments.
  3. Once an issue has been successfully reviewed and comments answered, you can mark it as closed.
  4. If you no longer have time to work on an issue, let us know in a comment so we can assign it someone else.