forked from matplotlib/matplotlib
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Backport PR matplotlib#26703: moved communications guidelines from go…
…vernance, updated and clarified process
- Loading branch information
1 parent
02aa131
commit 13bb274
Showing
7 changed files
with
257 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
.. _communications-guidelines: | ||
|
||
======================== | ||
Communication guidelines | ||
======================== | ||
|
||
These guidelines are applicable when acting as a representative of Matplotlib, | ||
for example at sprints or when giving official talks or tutorials, and in any | ||
community venue managed by Matplotlib. | ||
|
||
|
||
.. _communication-channels: | ||
|
||
Official communication channels | ||
=============================== | ||
The following venues are managed by Matplotlib maintainers and contributors: | ||
|
||
* library and docs: https://github.com/matplotlib/matplotlib | ||
* forum: https://discourse.matplotlib.org/ | ||
* chat: `https://matrix.to/#/#matplotlib:matrix.org <https://matrix.to/#/#matplotlib:matrix.org>`_ | ||
* blog: https://blog.scientific-python.org/ | ||
|
||
.. _social-media: | ||
|
||
Social media | ||
------------ | ||
|
||
Active social media | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
* https://twitter.com/matplotlib | ||
* https://instagram.com/matplotart/ | ||
|
||
Official accounts | ||
^^^^^^^^^^^^^^^^^ | ||
* https://bsky.app/profile/matplotlib.bsky.social | ||
* https://fosstodon.org/@matplotlib | ||
* https://www.tiktok.com/@matplotart | ||
* https://www.youtube.com/matplotlib | ||
|
||
|
||
.. _mailing-lists: | ||
|
||
Mailing lists | ||
------------- | ||
|
||
* `[email protected] <https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ | ||
* `[email protected] <https://mail.python.org/mailman/listinfo/matplotlib-users>`_ | ||
* `[email protected] <https://mail.python.org/mailman/listinfo/matplotlib-devel>`_ | ||
|
||
.. _social-media-coordination: | ||
|
||
Social media coordination | ||
------------------------- | ||
* Team mailing list: [email protected] | ||
* Public chat room: `https://matrix.to/#/#matplotlib_community:gitter.im <https://matrix.to/#/#matplotlib_community:gitter.im>`_ | ||
|
||
|
||
Maintenance | ||
----------- | ||
|
||
If you are interested in moderating the chat or forum or accessing the social | ||
media accounts: | ||
|
||
* Matplotlib maintainers should reach out to the `community-manager`_. | ||
|
||
* Everyone else should send an email to [email protected]: | ||
|
||
* Introduce yourself - github handle and participation in the community. | ||
* Describe the reason for wanting to moderate or contribute to social. | ||
|
||
|
||
Content guidelines | ||
================== | ||
|
||
Communication on official channels, such as the Matplotlib homepage or on | ||
Matplotlib social accounts, should conform to the following standards. If you | ||
are unsure if content that you would like to post or share meets these | ||
guidelines, ask on the :ref:`social-media-coordination` channels before posting. | ||
|
||
General guidelines | ||
------------------ | ||
|
||
* Focus on Matplotlib, 3rd party packages, and visualizations made with Matplotlib. | ||
* These are also acceptable topics: | ||
|
||
* Visualization best practices and libraries. | ||
* Projects and initiatives by NumFOCUS and Scientific Python. | ||
* How to contribute to open source projects. | ||
* Projects, such as scientific papers, that use Matplotlib. | ||
|
||
* No gratuitous disparaging of other visualization libraries and tools, but | ||
criticism is acceptable so long as it serves a constructive purpose. | ||
|
||
* Follow communication best practices: | ||
|
||
* Do not share non-expert visualizations when it could cause harm: | ||
|
||
* e.g. https://twitter.com/matplotlib/status/1244178154618605568 | ||
|
||
* Clearly state when the visualization data/conclusions cannot be verified. | ||
* Do not rely on machine translations for sensitive visualization. | ||
|
||
* Verify sourcing of content (especially on instagram & blog): | ||
|
||
* Instagram/blog: ensure mpl has right to repost/share content | ||
* Make sure content is clearly cited: | ||
|
||
* e.g. a tutorial reworking an example must credit the original example | ||
|
||
* Limited self/corporate promotion is acceptable. | ||
|
||
* Should be no more than about a quarter of the content. | ||
|
||
Visual media guidelines | ||
----------------------- | ||
|
||
Visual media, such as images and videos, must not violate the | ||
:ref:`code of conduct <code_of_conduct>`, nor any platform's rules. | ||
Specifically: | ||
|
||
* Visual media must conform to the guidelines of all sites it may be posted on: | ||
|
||
* https://help.twitter.com/en/rules-and-policies/twitter-rules | ||
* https://help.instagram.com/477434105621119 | ||
|
||
* Emphasize the visualization techniques demonstrated by the visual media. | ||
* Clearly state that sharing is not an endorsement of the content. | ||
|
||
* e.g. bitcoin related visualizations | ||
|
||
Accessibility | ||
^^^^^^^^^^^^^ | ||
|
||
Visual media in communications should be made as accessible as possible: | ||
|
||
* Add alt text to images and videos when the platform allows: | ||
|
||
* `alt text for data viz <https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81>`_ | ||
* `general alt text guide <https://webaim.org/techniques/alttext/>`_ | ||
|
||
* Warn on bright, strobing, images & turn off autoplay if possible. | ||
* For images and videos made by the social media team: | ||
|
||
* Make graphic perceivable to people who cannot perceive color well due to | ||
color-blindness, low vision, or any other reason. | ||
|
||
* Do not make bright, strobing images. | ||
* More guidelines at https://webaim.org/techniques/images/. | ||
|
||
|
||
Social media | ||
============ | ||
|
||
Please follow these guidelines to maintain a consistent brand identity across | ||
platforms. | ||
|
||
Persona | ||
------- | ||
On social media, Matplotlib: | ||
|
||
* Acts as a sentient visualization library, so talks about itself as a we, us, | ||
our, and it. Avoids talking about itself in the 3rd person. Never uses 1st person. | ||
* Is very earnest, eager to please, and aims to be patient & painfully oblivious | ||
to snark and sarcasm. | ||
* Gets over-excited over shiny visualizations - lots of emojis and the like - | ||
and encourages folks to share their work. | ||
* Highlights various parts of the library, especially the more obscure bits and | ||
bobbles. | ||
* 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. | ||
|
||
|
||
Behavior | ||
-------- | ||
When acting as a representative of the library, keep responses polite and assume | ||
user statements are in good faith unless they violate the :ref:`code of conduct <code_of_conduct>`. | ||
|
||
Social graph | ||
------------ | ||
|
||
Only follow **organizations and projects**, do not follow individual accounts for | ||
any reason, even maintainers/project leads/famous Python people! | ||
|
||
Following these types of accounts is encouraged: | ||
|
||
* NumFocus and Scientific Python projects | ||
* 3rd party packages | ||
* Visualization related projects and organizations | ||
* Open Source community projects | ||
* Sponsors | ||
|
||
Recurring campaigns | ||
------------------- | ||
|
||
Typically the social media accounts will promote the following: | ||
|
||
* Matplotlib releases: | ||
|
||
* Highlight new features & major deprecations | ||
* Link to download/install instructions | ||
* Ask folks to try it out. | ||
|
||
* `third party packages <https://matplotlib.org/mpl-third-party/>`_ | ||
* NumFocus/Scientific Python/open source visualization project releases | ||
* GSOC/GSOD recruiting and progress | ||
|
||
Retired campaigns | ||
^^^^^^^^^^^^^^^^^ | ||
* John Hunter Excellence in Plotting, submission and winners | ||
|
||
|
||
Changing the guidelines | ||
======================= | ||
|
||
As the person tasked with implementing communications, the `community-manager`_ | ||
should be alerted to proposed changes to the communications guidelines. Similarly, | ||
specific platform guidelines (e.g. twitter, instagram) should be reviewed by the | ||
person responsible for that platform, when different from the community manager. | ||
If there is no consensus, decisions about communications guidelines revert to | ||
the community manager. | ||
|
||
.. _community-manager: https://matplotlib.org/governance/people.html#deputy-project-leads |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -167,6 +167,7 @@ Policies and guidelines | |
:maxdepth: 1 | ||
|
||
release_guide | ||
communication_guide | ||
min_dep_policy | ||
MEP/index | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -455,22 +455,21 @@ Due to branch protections for the ``main`` branch, this is merged via a standard | |
request, though the PR cleanliness status check is expected to fail. The PR should not | ||
be squashed because the intent is to merge the branch histories. | ||
|
||
Announcing | ||
========== | ||
Publicize this release | ||
====================== | ||
|
||
The final step is to announce the release to the world. A short | ||
version of the release notes along with acknowledgments should be sent to | ||
After the release is published to PyPI and conda, it should be announced | ||
through our communication channels: | ||
|
||
- [email protected] | ||
- [email protected] | ||
- [email protected] | ||
|
||
In addition, announcements should be made on social networks (e.g., Twitter via the | ||
``@matplotlib`` account, any other via personal accounts). | ||
|
||
Add a release announcement to the ``mpl-brochure-site`` "News" section of | ||
``docs/body.html``, linking to the discourse page for the announcement. | ||
.. rst-class:: checklist | ||
|
||
* Send a short version of the release notes and acknowledgments to all the :ref:`mailing-lists` | ||
* Post highlights and link to :ref:`What's new <release-notes>` on the | ||
active :ref:`social media accounts <social-media>` | ||
* Add a release announcement to the "News" section of | ||
`matplotlib.org <https://github.com/matplotlib/mpl-brochure-site>`_ by editing | ||
``docs/body.html``. Link to the auto-generated announcement discourse post, | ||
which is in `Announcements > matplotlib-announcements <https://discourse.matplotlib.org/c/announce/matplotlib-announce/10>`_. | ||
|
||
Conda packages | ||
============== | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters