Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 2526e51

Browse filesBrowse files
committed
ported communications guide to development guide
1 parent b318dbf commit 2526e51
Copy full SHA for 2526e51

File tree

Expand file treeCollapse file tree

2 files changed

+122
-0
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+122
-0
lines changed

‎doc/devel/communication_guide.rst

Copy file name to clipboard
+121Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
.. _communications-guidelines:
2+
3+
========================
4+
Communication guidelines
5+
========================
6+
7+
These guidelines are applicable when acting as a representative of Matplotlib,
8+
for example at sprints or when giving official talks or tutorials, and in any
9+
community venue managed by Matplotlib.
10+
11+
.. _communication-channels:
12+
13+
Official communication channels
14+
===============================
15+
The following venues are managed by Matplotlib maintainers and contributors:
16+
17+
* https://github.com/matplotlib/matplotlib
18+
* https://discourse.matplotlib.org/
19+
* https://gitter.im/matplotlib/
20+
* https://github.com/matplotlib/matplotblog
21+
22+
23+
Social Media
24+
------------
25+
26+
* https://twitter.com/matplotlib
27+
* https://instagram.com/matplotart/
28+
* https://www.tiktok.com/@matplotart
29+
30+
31+
Mailing lists
32+
----------------
33+
34+
* https://mail.python.org/mailman/listinfo/matplotlib-announce
35+
* https://mail.python.org/mailman/listinfo/matplotlib-users
36+
* https://mail.python.org/mailman/listinfo/matplotlib-devel
37+
38+
.. _social-media-coordination:
39+
40+
Social media coordination
41+
-------------------------
42+
team mailing list: matplotlib-social@numfocus.org
43+
public chat room: https://gitter.im/matplotlib/community
44+
45+
Content guidelines
46+
====================
47+
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
70+
71+
Accessibility
72+
-------------
73+
Images in communications should be as accessible as possible:
74+
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/
83+
84+
85+
86+
Social media account information
87+
================================
88+
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/)
93+
94+
Persona
95+
-------
96+
On social media, Matplotlib:
97+
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.
103+
104+
Social graph
105+
------------
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

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ Policies and guidelines
167167
:maxdepth: 1
168168

169169
release_guide
170+
communication_guide
170171
min_dep_policy
171172
MEP/index
172173

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.