[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: Please review: updated Contributor's Guide

On Feb 20, 2014, at 12:41, Ben Parees <bparees redhat com> wrote:

> I'd vote for some docs on testing.  Both a discussion of what tests exist and what they cover/how to run them, and maybe instructions on running tests against the PR as well (ie via the test tags), though that carries some risk of overwhelming the build infrastructure.

This is a great point, Ben. I mentioned that I need to talk about the Vagrant-based devenv, and this is why. One of the benefits of doing development that way is that you can run the same tests on a local instance that will automatically be run when a reviewer [merge]s a contributor's pull request on GitHub.

I can also add some notes on where to find the tests in each of the code areas.

Thanks for the review!

> Ben Parees | OpenShift
> ----- Original Message -----
>> From: "N. Harrison Ripps" <hripps redhat com>
>> To: dev lists openshift redhat com
>> Sent: Thursday, February 20, 2014 11:11:01 AM
>> Subject: Please review: updated Contributor's Guide
>> Hey all--
>> One of my goals right now is to make it as easy as possible for people to get
>> their hands on OpenShift source code. To that end, I've overhauled the
>> Contributors Guide with a lot more detail on how to get involved. If you
>> have a few minutes, I'd love to get some feedback on the current state of
>> the guide:
>> http://openshift.github.io/documentation/oo_contributors_guide.html
>> The first section is the super-basic stuff - terminal + git. After that,
>> though, the next section covers:
>> * Specific parts of the Origin code base
>> * Where to find the source, feature backlog and bug records for those parts
>> And finally there is a section on creating pull requests and getting them
>> reviewed.
>> Right now the information is okay but could be expanded upon. For instance,
>> as we solidify our Vagrant-based development environment, I'd like to add a
>> section on how to use it to do OpenShift development. If you've got any
>> ideas for changes or improvements, the source for the guide lives here:
>> https://github.com/openshift/origin-server/blob/master/documentation/oo_contributors_guide.adoc
>> If you submit any pull requests against the document, ping me and I will
>> review them for you. If you don't have the time to put together a pull
>> requests, responses to this thread are great, too -- I can incorporate those
>> changes for you.
>> Thanks,
>> Harrison
>> _______________________________________________
>> dev mailing list
>> dev lists openshift redhat com
>> http://lists.openshift.redhat.com/openshiftmm/listinfo/dev

Attachment: smime.p7s
Description: S/MIME cryptographic signature

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]