[Patternfly] Contributions guidelines to PatternFly

[Matt Carrano]

Hi Andres,

The process you have proposed sounds great and I like the idea of using
GitHub as a common repository for design as well as code.  I agree it will
make contributions easier and provide a way to file issues against a design
pattern that can help our work evolve and improve.  True, we designers will
need to become more proficient in Git, but hey, it's just another tool to
learn.

My only minor concern is the use of Markdown to create documents rather
than Google Docs as is the current practice.  The markdown syntax seems
simple enough to learn, but we would loose some of the more robust inline
commenting features which make Google Docs great for collaboration.  Will
these markdown documents be directly consumable into the site?  If so, I
see this as a major advantage.

Anyway, I'm willing to give this a try, but it might make sense to pilot
one or two pattern efforts to see how this goes.

Matt

On Tue, Jun 14, 2016 at 1:05 PM, Andres Galante <agalante at redhat.com> wrote:

> Hi,
>
> We've wrote new Contribution Guidelines to improve the way we get
> contributions to patternfly, and find a path for designers to participate
> in the community.
>
> We want to centralise everything in github.
>
> At the moment designs patterns don’t have a real place, they are spread on
> docs, or on the website.
>
> We want for design specs to be living document with a fiscal
> representation on a github repo just as we do it with code.
>
> The process to send code is though a github pull request. That pull
> request gets discuss and merge. And if we see an bug in it, we open an
> issue and send a new pull request with the fix. That fix is discuss again
> and merge.
>
> The idea is to follow the same process for designs and designers.
>
> We will have a repo for designs, where designers will send markdown
> documents. Markdown allows to easily write text and add images to describe
> the pattern.
>
> Designers will send design draft on Pull Request, where we will held
> design discussions
>
> Once we merge the design draft, it becomes a design recommendation. But of
> course, since it is also a living document we can send new PRs up update it.
>
> This will also allow to easily cross reference design and code PRs in
> Patternfly and with other projects.
>
> What's the cost? Designers will have to learn git. But don’t worry it's
> not that hard. Once you do it once then it becomes second nature, plus its
> super fun and it's the way open source communities works.
>
> To pull all of this together we've wrote new contribution guidelines, and
> I'd love to hear your thoughts before posting them to the project:
>
> https://gist.github.com/andresgalante/a0d8238d8cd448b14eac9c377e76d489
>
> Thanks!
>
> _______________________________________________
> Patternfly mailing list
> Patternfly at redhat.com
> https://www.redhat.com/mailman/listinfo/patternfly
>
>


-- 
Matt Carrano
Sr. Interaction Designer
Red Hat, Inc.
mcarrano at redhat.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/patternfly/attachments/20160614/d293fa96/attachment.htm>