Skip to content

Instantly share code, notes, and snippets.

@wouterj

wouterj/README.md

Forked from weaverryan/README.md
Last active May 21, 2016 12:59
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save wouterj/7fceee9ea75727dbfab720f82950d196 to your computer and use it in GitHub Desktop.
Save wouterj/7fceee9ea75727dbfab720f82950d196 to your computer and use it in GitHub Desktop.
Download ZIP
Welcome to Symfony Documentation Hack Day May 21st, 2016
Raw
README.md

It's a Doc Hack Day!

Welcome! No matter what you're level of Symfony or how you feel about your English (I'm sure it's just fine), we have plenty of things we need help with! This document will guide you through everything:

Where are we meeting?

We're meeting on Freenode in the #symfony-docs channel. Come hang out!

What can I work on?

All open issues and pull requests can be viewed on GitHub. During the documentation hack day, you can help us with 2 tasks:

If you like to see a video tutorial, watch this little workshop by Ryan Weaver: https://www.youtube.com/watch?v=KIumadaMdX0

Reviewing Pull Requests

A huge part of the issue list contains pull requests. Before merging, each pull request has to be reviewed. This is where you can help!

  1. Pick a pull request. You can pick any open pull request that doesn't have the Finished label. Some pull requests are marked as Hack Day, these are nice pull requests to start reviewing.

  2. Review it! During review, you can answer questions like:

    • Is the added documentation easy to read and understand?
    • Is the added documentation correct?
    • Is the pull requests targeting the correct version?

    While reviewing pull requests, comment on a specific line or on the pull request if you find something that could be improved.

  3. Update status. After you've reviewed a pull request, comment on it indicating if it's the most awesome pull request you've seen or if you think it needs some more work in order to be finished.

    Always keep in mind that the author is a volunteer and gratefully thank him/her for their contribution.

Fixing Issues

Another task where you can help is by creating new pull requests.

  1. Find an issue. Check the open issue list on GitHub and pick an issue to work on. Issue labels can help you, some labels to look out for:

    • Labels with components that you are familair with
    • The Actionable and Easy Pick labels, these issues are ready to work on.
    • The Needs comments labels. These issues need the input of other people.

  2. Claim the issue. Comment on the issue indicating that you're going to work on it. This avoids duplicated pull requests fixing the same issue.

  3. Work on it! Sometimes this means just commenting on a ticket, other times it means creating a pull request. Do whatever you feel comfortable. Every task needs its own work. As soon as you've started something, create a PR and prefix the title with [WIP]. This lets everyone comment and collaborate on it while you're working. When it's finished, just remove the prefix.

    If you're new to contributing, check out Contributing to the Documentation. We use a format called reStructuredText. But don't worry, we're really nice and we'll help you out along the way.

  4. Finish the work or what you can! One way or another, when you're done, add comments to your PR that you think will be helpful.

And have fun! Do what you can - we appreciate the help.

Have questions or want to high-five online?

We'll be hanging out in the #symfony-docs channel on Freenode - find WouterJ, weaverryan, xabbuh or javiereguiluz, and we'll be happy to chat with you. Everyone else there will be nice too - it's the documentation, so it's a pretty-easy going group :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment