Hi, On Sun, Mar 9, 2014 at 4:05 AM, Dave <[email protected]> wrote: > I added a page to our website that explains how to contribute code to > Usergrid: > > http://usergrid.incubator.apache.org/docs/contribute-code/ > > Feedback is most welcome. Do I need to add more details? Should I show > every command? Am I missing other important points? >
this first version looks already pretty complete to me. Some suggestions for improvement: The "contribute to this article on github" link is broken (404). It points to the (old?) usergrid/website project on GitHub. You can ask infra to sync the usergrid/site folder in asf's svn repo to a usergrid-docs git repo under the apache account in GitHub and then clone it in your usergrid account, so that a) this link actually works and b) contributions can be submitted via a pull request. In the "For small fixes" section, the "Get a GitHub account" step is also required, so I'd add it. Assuming that you also accept patches from devs without GitHub account, I also propose to add something similar to: "If you don't have or don't want to create a GitHub account, you can send your patch as attachment to a mail to the usergrid development mailing list." In the "For big changes" section. The "Wait a bit for your Pull Request to be reviewed and merged" line doesn't mention that bigger changes typically take some discussion and updating before the patch gets committed. This in itself is fairly obvious, but I do think you should add whether this discussion takes place in the GitHub comments section of the pull request or on the dev mailing list, or both. On a related note, I'm only following the dev mailing list and I noticed that not a lot of design/patch discussion is going on. At first I though the project wasn't very active, but later I found that there's actually a lot going on in GitHub (great!) that's not reaching the dev list (not so great). What's the status of the plan to sync all github pull requests and comments to the dev list? The "For big changes" section also mentions "don't forget to create tests". A pointer to some more info about how to write tests would be helpful here. For instance, what tool is used for integration testing the stack, how to mock the stack when testing the sdk's etc. > I plan to add another page that explains how to contribute documentation > and website changes. Yeah, good idea. Lieven > Thanks, > Dave
