Pull requests & you
This is a quick overview of pull requests for Vanilla and how the community can help get releases out the door faster.
The very basics:
- Fork the repository. (You won't be able to push to our repos directly.)
- Pull request against
masterbranch (FROM the branch on your fork TO our copy's
- Verify you have a CLEAN pull request without extra garbage in the change set.
- Write a great, release-notes-worthy title for the pull request.
- Write a well-considered description that details the changes being made & your rationale.
- Treat GitHub as an extension of the community: be friendly, say hello to new folks, etc.
- Mention what you've done to test it already, and what others should be looking at in their tests.
Beyond the basics:
Community evaluation of pull requests would be tremendously helpful. I realize you can't merge PRs, but there's a lot of work that happens before we get that far. And, you'll learn a tremendous amount by jumping in.
If you don't have a deep Vanilla understanding, you can look at the superficial: does it meet our coding standards and naming conventions? Is it a decent idea? Is it free of syntax errors? Has the user signed our contributors' agreement?
If you've been around a while and have been building some serious addons, go further: Is this a safe & sane idea? Can you test it in multiple scenarios to see if it causes a regression or unintended consequences? Is this a Vanilla-like thing to do? Is there already a simpler way to accomplish what the author wants without their change? (e.g.: if they say they need a hook to do X, do you know an existing hook or better way to do it?)
When you evaluate a PR, say so in the comments. We're not looking for cheerleader comments like "yay good idea", but rather "I agree this is an issue/good improvement because I've seen X or understand what they're trying to accomplish. I tested this PR by doing exactly W, Y, and Z and these were my results".
The backlog is a bit long right now, but we're gonna get 'er done. Keep pullin'!