I just wanted to say thanks to the Platform Team - specifically to Rouven, Andrew, Louis, Ian, and Christoper for your work on github handling the pull requests.
My recent experience helping with the Jerror/Exception effort was perhaps the best experience I have had contributing to the Joomla project because of the patience and help each of you provided.
It's fair to say that contributing has gotten a more complex. One needs to understand git, how to create branches and learning how to rebase can cover a multitude of sin. There's also a bit of setup required to get unit tests and code sniffing and Docbook going. I'm going to try to document some of these steps in order to pass on the help I was given.
But, I think the added measures are necessary and already demonstrate better code quality and results. I am also confident these skills are prevalent in the PHP dev world, so, it should help gain the involvement of others.
The team is doing a great job -- positive and encouraing interactions with contributors, and clear instructions as to what needs to be done. I very much appreciate it.
Finished a draft of a workflow of sorts and beginning github commands for developers. Would appreciate any comments that might help developers get started with git. I hope to have it in the Joomla Community Magazine next month.
> Finished a draft of a workflow of sorts and beginning github commands for > developers. Would appreciate any comments that might help developers get > started with git. I hope to have it in the Joomla Community Magazine next > month.
But, can you please, maybe with help with someone from JBS, also show the wordflow for push to CMS? In the same text, or in a new one? There's a good chance that new people, especially who are not accustomed to using github, tend to send suggestions to the CMS, and not to the platform, and the routine is a little different.
On Wed, Apr 18, 2012 at 19:35, Andrew Eddie <mambob...@gmail.com> wrote: > Looks good Amy. We can link it off the the github wiki when it's > published.
> On 19 April 2012 08:07, Amy Stephen <amystep...@gmail.com> wrote:
> > Finished a draft of a workflow of sorts and beginning github commands for > > developers. Would appreciate any comments that might help developers get > > started with git. I hope to have it in the Joomla Community Magazine next > > month.
The CMS have their own workflow that still revolves around the JoomlaCode tracker and manual patch files. I'd probably err on the side of keeping them separate.
> But, can you please, maybe with help with someone from JBS, also show the > wordflow for push to CMS? In the same text, or in a new one? There's a good > chance that new people, especially who are not accustomed to using github, > tend to send suggestions to the CMS, and not to the platform, and the > routine is a little different.
> emerson > -- > Emerson da Rocha Luiz > +55 51 9881-9146 | MSN: emerson at webdesign.eng.br | GTalk: fititnt at > Gmail | Skype: fititnt | http://www.fititnt.org | Twitter: @fititnt > Membro do JUGRS | Membro do JCoderBR
> On Wed, Apr 18, 2012 at 19:35, Andrew Eddie <mambob...@gmail.com> wrote:
>> Looks good Amy. We can link it off the the github wiki when it's >> published.
>> On 19 April 2012 08:07, Amy Stephen <amystep...@gmail.com> wrote:
>> > Finished a draft of a workflow of sorts and beginning github commands >> > for >> > developers. Would appreciate any comments that might help developers get >> > started with git. I hope to have it in the Joomla Community Magazine >> > next >> > month.
I *love* the "Try not to be offended when given instruction by
maintainers", specially the "Try" at the beginning. :-D
(make it bold underlined italic extra-large LOL).
At begin i found it a bit lengthy, but shortening would probably make
it less clear.
One small improvement suggestion (please don't be offended, it's
really a small thing inside an excellent document):
The last "Staying Current"/"Fetch or Merge" paragraph is a bit shorter
worded than the rest, and indeed it appears less clear than the rest,
specially for someone used to just do an "svn update" to stay up-to-
date. Also it is not 100% clear in that paragraph what exactly needs
to be done where and in exactly which folder to not only keep the
local copy up-to-date, but also to keep the distant pull request up to
date. Maybe an example "screenshot" of commands could help there too.
> Finished a draft of a workflow of sorts and beginning github commands for
> developers. Would appreciate any comments that might help developers get
> started with git. I hope to have it in the Joomla Community Magazine next
> month.
You caught me. The reason the fetch and merge sounds a little *sketchy* is that my knowledge in that area is still at the tadpole stage. I'll work with that and experiment until I understand it a bit more.
Also, without the introductory stuff, maybe this could be a chapter in the Docbook? (Andrew?) That way, Emerson, when the CMS decides to finally let go of our past and embrace our future with github, the documentation should help those contributors as well.
Yes, that was a little poke. But, not at anyone in particular. ;-)
On Thu, Apr 19, 2012 at 4:35 AM, Beat <beat...@gmail.com> wrote: > Well done, Amy !
> Very clear instructions.
> I *love* the "Try not to be offended when given instruction by > maintainers", specially the "Try" at the beginning. :-D
> (make it bold underlined italic extra-large LOL).
> At begin i found it a bit lengthy, but shortening would probably make > it less clear.
> One small improvement suggestion (please don't be offended, it's > really a small thing inside an excellent document):
> The last "Staying Current"/"Fetch or Merge" paragraph is a bit shorter > worded than the rest, and indeed it appears less clear than the rest, > specially for someone used to just do an "svn update" to stay up-to- > date. Also it is not 100% clear in that paragraph what exactly needs > to be done where and in exactly which folder to not only keep the > local copy up-to-date, but also to keep the distant pull request up to > date. Maybe an example "screenshot" of commands could help there too.
> On Apr 19, 12:07 am, Amy Stephen <amystep...@gmail.com> wrote: > > Finished a draft of a workflow of sorts and beginning github commands for > > developers. Would appreciate any comments that might help developers get > > started with git. I hope to have it in the Joomla Community Magazine next > > month.
On 19 April 2012 20:34, Amy Stephen <amystep...@gmail.com> wrote:
> Also, without the introductory stuff, maybe this could be a chapter in the > Docbook? (Andrew?) That way, Emerson, when the CMS decides to finally let go > of our past and embrace our future with github, the documentation should > help those contributors as well.
> Yes, that was a little poke. But, not at anyone in particular. ;-)