Browse files

Add "Before you begin" section to

Trying to better set expectations about contributing and avoid anyone charging in with a PR that we weren't expecting and can't accept.
  • Loading branch information...
mrlacey committed Sep 26, 2017
1 parent 154bda3 commit 33034edd3c79078c80018a8bc9ec0f2c543c1fc0
Showing with 9 additions and 0 deletions.
  1. +9 −0
@@ -8,6 +8,15 @@ That's why many of the guidelines of this document are obvious and serve only on
Also remeber that the Pull Requests must be done aganist the **[dev branch](**.
## Before you begin
While we're grateful for any and all contributions, we don't want you to waste anyone's time. Please consider the following points before you start working on any contribution.
* Please comment on an issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it enables us to make sure everyone is clear on what should be done to implement any new functionality. It's less work for everyone, in the long run, to establish this up front.
* The code that is output in the generated projects may end up in thousands of apps so it must be of the highest quality. Expect it to be reviewed very thoroughly and it must meet our standards for standards for style, structure, and format.There are details below and automated tests to verify their use.
* Get familiar with the automated tests that are part of the project. With so many possible combinations of output, it's impossible to verify everything manually. You will need to make sure they all pass.
* When adding anything new it should be created to work with all supported frameworks. If this is going to be a problem, discuss it before beginning work.
## A good pull request
Every contribution has to come with:

0 comments on commit 33034ed

Please sign in to comment.