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:
We're meeting on Freenode in the #symfony-docs channel. Come hang out!
That's such a cool question :). We have a Google Doc:
https://docs.google.com/spreadsheets/d/1BXQjyCOnnCFD-zMrAoakq_VrNeSSGcDFCsRxHnXxJ1g/edit?usp=sharing
In this spreadsheet, you can see a big list of issues. Some are easy, others are harder or take more time. Some might be done, others are waiting for you. Check out the Level to find something
- Easy
- Intermediate
- Advanced
- Needs Conversation (These have some unanswered question on the ticket that needs the community's review. Sometimes the question has nothing to do with Symfony even - we need your expertise to move this forward!)
If you're new to contributing, check out "Contributing to the Documentation patches". We use a format called reStructuredText.
But don't worry, we're really nice and we'll help you out along the way.
-
Find something to work on. When you've chosen something, just put your name on the spreadsheet. Don't worry, that doesn't commit you to have to finish it - but we hope you do. You can always take your name off of it later.
Can't find something or have questions? Find WouterJ, xabbuh or weaverryan in the #symfony-docs channel.
-
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. -
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 (or update the spreadsheet with any notes if there is no PR to comment on).
And have fun! Do what you can - we appreciate the help.
Sometimes, pull requests are started, but the original person gets busy and can't finish it. And that's ok. As part of the spreadsheet, we've identified PR's that need a new owner in the "pull requests" tab. Think of it like adopting a friendly dog and giving it a new home.
Take #4257 as an example. If you wanted to adopt this PR, you would:
-
Mark that you're working on it on the spreadsheet
-
Checkout the original submitter's branch, so you can build on top of their work. Use the submitter's username and the branch name at the top of the PR to know exactly what to "pull":
git checkout -b inoryy-abstract-voter git pull https://github.com/Inoryy/symfony-docs.git abstract-voter
-
Work away and get this guy finished!
-
Open a brand new pull request. Inside it, comment that this replaces the original #4257 pull request.
-
Add a comment on the original pull request with a link to your new one. Then, we'll be able to close it.
-
Celebrate - because we <3 you - helping along stalled pull requests is one of the most important things we need!
We'll be hanging out in the #symfony-dev channel on Freenode - find WouterJ, xabbuh or weaverryan, 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 :).