[Openstack-docs] Community communications guidelines proposal
Nicholas Chase
nchase at mirantis.com
Sat Dec 14 21:42:24 UTC 2013
I like the examples as well. I think it DOES go under the
"Documentation" umbrella -- the way that anything that explains how to
develop or use OpenStack effectively does. I think that the
CodeReviewGuidelines are a subset of this; the two should crosslink, so
that you can go from one to the other easily.
I also think that this content should be as obvious as "How to
contribute"; it's really pretty important.
---- Nick
On 12/13/2013 6:36 PM, Anne Gentle wrote:
> Hi all,
> I liked Matthew's examples of how to nicely suggest improvements to
> commit messages, review comments, and so on. Something about a
> monocle-wearing English gentleman's polite speech leads me to believe
> that our community members would appreciate some guidelines and
> training, but I don't know how others feel about this under a
> "Documentation" umbrella. Perhaps it belongs with the
> CodeReviewGuidelines? More input and discussion -- with the idea being,
> how can we help improve communication around the code and docs?
> Thanks,
> Anne
>
>
> On Thu, Dec 12, 2013 at 2:38 AM, Matthew Mosesohn
> <mmosesohn at mirantis.com <mailto:mmosesohn at mirantis.com>> wrote:
>
> Hi Stackers,
>
> After some discussion about the Code Review Guidelines
> (https://wiki.openstack.org/wiki/CodeReviewGuidelines), it's come to
> my attention that there is plenty of advice that could be shared with
> the rest of the community about how to participate effectively, yet
> respectfully, in various forms of communication. The scope of
> communication I want to cover includes messages on IRC, mailing lists,
> code review, and commit messages. It's quite obvious for most of you
> that kindness and respect for your fellow developer helps reduce
> friction that may arise when trying to contribute to OpenStack or get
> help.
>
> The intended audience for this discussion is not our core contributors
> who speak English as a native language, but instead for those who are
> interested in participating, but need to improve their writing skills.
> Frankly speaking, in some languages, direct speech can seem harsh when
> written literally in English.
>
> After speaking with Anne Gentle, she suggested creating a
> communcations guideline page as a child page under
> https://wiki.openstack.org/wiki/Documentation/Conventions with a
> similar format, showing correct and incorrect models of communication.
>
> The intent of starting this thread is to field some suggestions or
> possibly point out some examples of items that should be included in
> this document. I'm not asking for serious investment from the Docs
> team, but if you have ideas, please feel free to share them. Thank you
> for your time.
>
> Best Regards,
> Matthew Mosesohn
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> <mailto:Openstack-docs at lists.openstack.org>
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
>
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
More information about the Openstack-docs
mailing list