@@ -30,55 +30,56 @@ existing issue and pull request discussions, and following the conversations
3030during pull request reviews to get context. Or you can deep-dive into a subset
3131of the code-base to understand what is going on.
3232
33- Do I really have something to contribute to Matplotlib?
34- -------------------------------------------------------
35-
36- 100% yes. There are so many ways to contribute to our community. Take a look at
37- the next sections to learn more. There are a few typical new contributor
38- profiles:
39-
40- * **You are a Matplotlib user, and you see a bug, a potential improvement, or
41- something that annoys you, and you can fix it. **
42-
43- You can search our issue tracker for an existing issue that describes your problem or
44- open a new issue to inform us of the problem you observed and discuss the best approach
45- to fix it. If your contributions would not be captured on GitHub (social media,
46- communication, educational content), you can also reach out to us on gitter _,
47- `Discourse <https://discourse.matplotlib.org/ >`__ or attend any of our `community
48- meetings <https://scientific-python.org/calendars> `__.
49-
50- * **You are not a regular Matplotlib user but a domain expert: you know about
51- visualization, 3D plotting, design, technical writing, statistics, or some
52- other field where Matplotlib could be improved. **
53-
54- Awesome -- you have a focus on a specific application and domain and can
55- start there. In this case, maintainers can help you figure out the best
56- implementation; open an issue or pull request with a starting point, and we'll
57- be happy to discuss technical approaches.
58-
59- If you prefer, you can use the `GitHub functionality for "draft" pull requests
60- <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft> `__
61- and request early feedback on whatever you are working on, but you should be
62- aware that maintainers may not review your contribution unless it has the
63- "Ready to review" state on GitHub.
64-
65- * **You are new to Matplotlib, both as a user and contributor, and want to start
66- contributing but have yet to develop a particular interest. **
67-
68- Having some previous experience or relationship with the library can be very
69- helpful when making open-source contributions. It helps you understand why
70- things are the way they are and how they *should * be. Having first-hand
71- experience and context is valuable both for what you can bring to the
72- conversation (and given the breadth of Matplotlib's usage, there is a good
73- chance it is a unique context in any given conversation) and make it easier to
74- understand where other people are coming from.
75-
76- Understanding the entire codebase is a long-term project, and nobody expects
77- you to do this right away. If you are determined to get started with
78- Matplotlib and want to learn, going through the basic functionality,
79- choosing something to focus on (3d, testing, documentation, animations, etc.)
80- and gaining context on this area by reading the issues and pull requests
81- touching these subjects is a reasonable approach.
33+ .. dropdown :: Do I really have something to contribute to Matplotlib?
34+ :open:
35+ :icon: person-add
36+
37+ 100% yes. There are so many ways to contribute to our community. Take a look at
38+ the next sections to learn more. There are a few typical new contributor
39+ profiles:
40+
41+ * **You are a Matplotlib user, and you see a bug, a potential improvement, or
42+ something that annoys you, and you can fix it. **
43+
44+ You can search our issue tracker for an existing issue that describes your problem or
45+ open a new issue to inform us of the problem you observed and discuss the best approach
46+ to fix it. If your contributions would not be captured on GitHub (social media,
47+ communication, educational content), you can also reach out to us on gitter _,
48+ `Discourse <https://discourse.matplotlib.org/ >`__ or attend any of our `community
49+ meetings <https://scientific-python.org/calendars> `__.
50+
51+ * **You are not a regular Matplotlib user but a domain expert: you know about
52+ visualization, 3D plotting, design, technical writing, statistics, or some
53+ other field where Matplotlib could be improved. **
54+
55+ Awesome -- you have a focus on a specific application and domain and can
56+ start there. In this case, maintainers can help you figure out the best
57+ implementation; open an issue or pull request with a starting point, and we'll
58+ be happy to discuss technical approaches.
59+
60+ If you prefer, you can use the `GitHub functionality for "draft" pull requests
61+ <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft> `__
62+ and request early feedback on whatever you are working on, but you should be
63+ aware that maintainers may not review your contribution unless it has the
64+ "Ready to review" state on GitHub.
65+
66+ * **You are new to Matplotlib, both as a user and contributor, and want to start
67+ contributing but have yet to develop a particular interest. **
68+
69+ Having some previous experience or relationship with the library can be very
70+ helpful when making open-source contributions. It helps you understand why
71+ things are the way they are and how they *should * be. Having first-hand
72+ experience and context is valuable both for what you can bring to the
73+ conversation (and given the breadth of Matplotlib's usage, there is a good
74+ chance it is a unique context in any given conversation) and make it easier to
75+ understand where other people are coming from.
76+
77+ Understanding the entire codebase is a long-term project, and nobody expects
78+ you to do this right away. If you are determined to get started with
79+ Matplotlib and want to learn, going through the basic functionality,
80+ choosing something to focus on (3d, testing, documentation, animations, etc.)
81+ and gaining context on this area by reading the issues and pull requests
82+ touching these subjects is a reasonable approach.
8283
8384.. _contribute_code :
8485
@@ -344,10 +345,10 @@ A brief overview of the workflow is as follows.
344345GitHub Codespaces workflows
345346^^^^^^^^^^^^^^^^^^^^^^^^^^^
346347
347- * If you need to open a GUI window with Matplotlib output on Codespaces, our
348- configuration includes a `light-weight Fluxbox-based desktop
349- <https://github.com/devcontainers/features/tree/main/src/desktop-lite> `_.
350- You can use it by connecting to this desktop via your web browser. To do this:
348+ If you need to open a GUI window with Matplotlib output on Codespaces, our
349+ configuration includes a `light-weight Fluxbox-based desktop
350+ <https://github.com/devcontainers/features/tree/main/src/desktop-lite> `_.
351+ You can use it by connecting to this desktop via your web browser. To do this:
351352
352353 #. Press ``F1 `` or ``Ctrl/Cmd+Shift+P `` and select
353354 ``Ports: Focus on Ports View `` in the VSCode session to bring it into
@@ -356,14 +357,17 @@ GitHub Codespaces workflows
356357 #. In the browser that appears, click the Connect button and enter the desktop
357358 password (``vscode `` by default).
358359
359- Check the `GitHub instructions
360- <https://github.com/devcontainers/features/tree/main/src/desktop-lite#connecting-to-the-desktop> `_
361- for more details on connecting to the desktop.
360+ Check the `GitHub instructions
361+ <https://github.com/devcontainers/features/tree/main/src/desktop-lite#connecting-to-the-desktop> `_
362+ for more details on connecting to the desktop.
362363
363- * If you also built the documentation pages, you can view them using Codespaces.
364- Use the "Extensions" icon in the activity bar to install the "Live Server"
365- extension. Locate the ``doc/build/html `` folder in the Explorer, right click
366- the file you want to open and select "Open with Live Server."
364+ View documentation
365+ """"""""""""""""""
366+
367+ If you also built the documentation pages, you can view them using Codespaces.
368+ Use the "Extensions" icon in the activity bar to install the "Live Server"
369+ extension. Locate the ``doc/build/html `` folder in the Explorer, right click
370+ the file you want to open and select "Open with Live Server."
367371
368372
369373Open a pull request on Matplotlib
0 commit comments