Skip to content

Commit 22e2fe5

Browse files
story645timhoffm
andcommitted
updated communications guidelines with current information
Fix section title formatting Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
1 parent 2526e51 commit 22e2fe5

File tree

2 files changed

+158
-70
lines changed

2 files changed

+158
-70
lines changed

doc/devel/communication_guide.rst

Lines changed: 157 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,38 @@ These guidelines are applicable when acting as a representative of Matplotlib,
88
for example at sprints or when giving official talks or tutorials, and in any
99
community venue managed by Matplotlib.
1010

11+
12+
1113
.. _communication-channels:
1214

1315
Official communication channels
1416
===============================
1517
The following venues are managed by Matplotlib maintainers and contributors:
1618

17-
* https://github.com/matplotlib/matplotlib
18-
* https://discourse.matplotlib.org/
19-
* https://gitter.im/matplotlib/
20-
* https://github.com/matplotlib/matplotblog
19+
* library and docs: https://github.com/matplotlib/matplotlib
20+
* forum: https://discourse.matplotlib.org/
21+
* chat: `https://matrix.to/#/#matplotlib:matrix.org <https://matrix.to/#/#matplotlib:matrix.org>`_
22+
* blog: https://blog.scientific-python.org/
2123

22-
23-
Social Media
24+
Social media
2425
------------
2526

27+
Active social media
28+
^^^^^^^^^^^^^^^^^^^
29+
2630
* https://twitter.com/matplotlib
2731
* https://instagram.com/matplotart/
32+
33+
Official accounts
34+
^^^^^^^^^^^^^^^^^
35+
* https://bsky.app/profile/matplotlib.bsky.social
36+
* https://fosstodon.org/@matplotlib
2837
* https://www.tiktok.com/@matplotart
38+
* https://www.youtube.com/matplotlib
2939

3040

3141
Mailing lists
32-
----------------
42+
-------------
3343

3444
* https://mail.python.org/mailman/listinfo/matplotlib-announce
3545
* https://mail.python.org/mailman/listinfo/matplotlib-users
@@ -39,83 +49,161 @@ Mailing lists
3949

4050
Social media coordination
4151
-------------------------
42-
team mailing list: matplotlib-social@numfocus.org
43-
public chat room: https://gitter.im/matplotlib/community
52+
* Team mailing list: matplotlib-social@numfocus.org
53+
* Public chat room: `https://matrix.to/#/#matplotlib_community:gitter.im <https://matrix.to/#/#matplotlib_community:gitter.im>`_
54+
55+
56+
Maintenance
57+
-----------
58+
59+
If you are interested in moderating the chat or forum or accessing the social
60+
media accounts:
61+
62+
* Matplotlib maintainers should reach out to the `community-manager`_.
63+
64+
* Everyone else should send an email to matplotlib-social-admin@numfocus.org:
65+
66+
* Introduce yourself - github handle and participation in the community.
67+
* Describe the reason for wanting to moderate or contribute to social.
68+
4469

4570
Content guidelines
46-
====================
71+
==================
72+
4773
Communication on official channels, such as the Matplotlib homepage or on
48-
Matplotlib social accounts, should conform to the following standards:
49-
50-
- be primarily about Matplotlib, 3rd party packages, and visualizations made with Matplotlib
51-
- also acceptable topics: Python, Visualization, NumFOCUS libraries
52-
- no gratuitous disparaging of other visualization libraries and tools; criticism is acceptable so long as it serves a constructive purpose
53-
- follow visualization communication best practices
54-
- don't share non-expert visualizations when it could be harmful
55-
- put on meeting agenda when answer isn't clearly to hold off on sharing.
56-
- clearly state when the visualization data/conclusions cannot be verified
57-
- do not rely on machine translations for sensitive visualizations
58-
- example: https://twitter.com/matplotlib/status/1244178154618605568
59-
- verify sourcing of content (especially on instagram & blog)
60-
- Instagram/blog: ensure mpl has right to repost/share content
61-
- make sure content is clearly cited
62-
- example: a tutorial using someone else’s example clearly cites the original source
63-
- Limited self/corporate promotion is acceptable, but should be no more than about a quarter of the content of the blog/discourse post.
64-
- if you think content is borderline, ask on the :ref:`_social-media-coordination` channels before publishing it
65-
- acceptable image guide:
66-
- keep it geared towards science/data visualization, and non-controversial images
67-
- must be conform to the guidelines of all sites it may be posed on:
68-
- https://help.twitter.com/en/rules-and-policies/twitter-rules
69-
- https://help.instagram.com/477434105621119
74+
Matplotlib social accounts, should conform to the following standards. If you
75+
are unsure if content that you would like to post or share meets these
76+
guidelines, ask on the :ref:`social-media-coordination` channels before posting.
77+
78+
General guidelines
79+
------------------
80+
81+
* Focus on Matplotlib, 3rd party packages, and visualizations made with Matplotlib.
82+
* These are also acceptable topics:
83+
84+
* Visualization best practices and libraries.
85+
* Projects and initiatives by NumFOCUS and Scientific Python.
86+
* How to contribute to open source projects.
87+
* Projects, such as scientific papers, that use Matplotlib.
88+
89+
* No gratuitous disparaging of other visualization libraries and tools, but
90+
criticism is acceptable so long as it serves a constructive purpose.
91+
92+
* Follow communication best practices:
93+
94+
* Do not share non-expert visualizations when it could cause harm:
95+
96+
* e.g. https://twitter.com/matplotlib/status/1244178154618605568
97+
98+
* Clearly state when the visualization data/conclusions cannot be verified.
99+
* Do not rely on machine translations for sensitive visualization.
100+
101+
* Verify sourcing of content (especially on instagram & blog):
102+
103+
* Instagram/blog: ensure mpl has right to repost/share content
104+
* Make sure content is clearly cited:
105+
106+
* e.g. a tutorial reworking an example must credit the original example
107+
108+
* Limited self/corporate promotion is acceptable.
109+
110+
* Should be no more than about a quarter of the content.
111+
112+
Visual media guidelines
113+
-----------------------
114+
115+
Visual media, such as images and videos, must not violate the
116+
:ref:`code of conduct <code_of_conduct>`, nor any platform's rules.
117+
Specifically:
118+
119+
* Visual media must conform to the guidelines of all sites it may be posted on:
120+
121+
* https://help.twitter.com/en/rules-and-policies/twitter-rules
122+
* https://help.instagram.com/477434105621119
123+
124+
* Emphasize the visualization techniques demonstrated by the visual media.
125+
* Clearly state that sharing is not an endorsement of the content.
126+
127+
* e.g. bitcoin related visualizations
70128

71129
Accessibility
72-
-------------
73-
Images in communications should be as accessible as possible:
130+
^^^^^^^^^^^^^
74131

75-
- add alt text to images and videos when the platform allows
76-
- https://webaim.org/techniques/alttext/
77-
- https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81
78-
- warn on bright, strobing, images & turn off autoplay if possible
79-
- for images made by the social media team:
80-
- make graphic perceivable to people who cannot perceive color well, due to color-blindness or low vision
81-
- do not make bright, strobing images
82-
- more guidelines at https://webaim.org/techniques/images/
132+
Visual media in communications should be made as accessible as possible:
83133

134+
* Add alt text to images and videos when the platform allows:
84135

136+
* `alt text for data viz <https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81>`_
137+
* `general alt text guide <https://webaim.org/techniques/alttext/>`_
85138

86-
Social media account information
87-
================================
139+
* Warn on bright, strobing, images & turn off autoplay if possible.
140+
* For images and videos made by the social media team:
141+
142+
* Make graphic perceivable to people who cannot perceive color well due to
143+
color-blindness, low vision, or any other reason.
144+
145+
* Do not make bright, strobing images.
146+
* More guidelines at https://webaim.org/techniques/images/.
88147

89-
Behavior
90-
--------
91-
When acting as a representative of the library, keep responses polite, and assume
92-
user statements are in good faith unless they violate the [Code of Conduct](https://www.python.org/psf/conduct/)
148+
149+
Social media
150+
============
151+
152+
Please follow these guidelines to maintain a consistent brand identity across
153+
platforms.
93154

94155
Persona
95156
-------
96157
On social media, Matplotlib:
97158

98-
* Is a sentient visualization library, so talks about itself as a we, us, our, and it. Avoids talking about itself in the 3rd person.
99-
* Is very earnest, eager to please, and aims to be patient & painfully oblivious to snark and sarcasm.
100-
* Gets over-excited over shiny visualizations - lots of emojis and the like - and encourages folks to share their work.
101-
* Highlights various parts of the library, especially the more obscure bits and bobbles.
102-
* Acknowledges that it is a sometimes frustrating tangle of bits & bobbles that can confuse even the folks who work on it & signal boosts their confuzzlment.
159+
* Acts as a sentient visualization library, so talks about itself as a we, us,
160+
our, and it. Avoids talking about itself in the 3rd person. Never uses 1st person.
161+
* Is very earnest, eager to please, and aims to be patient & painfully oblivious
162+
to snark and sarcasm.
163+
* Gets over-excited over shiny visualizations - lots of emojis and the like -
164+
and encourages folks to share their work.
165+
* Highlights various parts of the library, especially the more obscure bits and
166+
bobbles.
167+
* Acknowledges that it is a sometimes frustrating tangle of bits & bobbles that
168+
can confuse even the folks who work on it & signal boosts their confuzzlment.
169+
170+
171+
Behavior
172+
--------
173+
When acting as a representative of the library, keep responses polite and assume
174+
user statements are in good faith unless they violate the :ref:`code of conduct <code_of_conduct>`.
103175

104176
Social graph
105177
------------
106-
- only follow organizations/projects - mostly NumFocus projects
107-
- especially 3rd party packages
108-
- should at least be visualization related
109-
- sponsors are also acceptable
110-
- do not follow individual accounts for any reason (even maintainers/project leads/Guido!)
111-
112-
Recurrent social campaigns
113-
--------------------------
114-
115-
- Release Announcements
116-
- Highlight new features & major deprecations
117-
- Link to download/install instructions
118-
- Ask folks to try it out.
119-
- signal boost third party packages
120-
- GSOC work during GSOC recruiting and work times
121-
- John Hunter Excellence in Plotting, submission and winners
178+
179+
Only follow **organizations and projects**, do not follow individual accounts for
180+
any reason, even maintainers/project leads/famous Python people!
181+
182+
Following these types of accounts is encouraged:
183+
184+
* NumFocus and Scientific Python projects
185+
* 3rd party packages
186+
* Visualization related projects and organizations
187+
* Open Source community projects
188+
* Sponsors
189+
190+
Recurring campaigns
191+
-------------------
192+
193+
Typically the social media accounts will promote the following:
194+
195+
* Matplotlib releases:
196+
197+
* Highlight new features & major deprecations
198+
* Link to download/install instructions
199+
* Ask folks to try it out.
200+
201+
* `third party packages <https://matplotlib.org/mpl-third-party/>`_
202+
* NumFocus/Scientific Python/open source visualization project releases
203+
* GSOC/GSOD recruiting and progress
204+
205+
Retired campaigns
206+
^^^^^^^^^^^^^^^^^
207+
* John Hunter Excellence in Plotting, submission and winners
208+
209+
.. _community-manager: https://matplotlib.org/governance/people.html#deputy-project-leads

doc/users/project/code_of_conduct.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. code_of_conduct
1+
.. _code_of_conduct:
22

33
====================================
44
Contributor Covenant Code of Conduct

0 commit comments

Comments
 (0)