diff --git a/doc/devel/contribute.rst b/doc/devel/contribute.rst index 7b2b0e774ec7..4eb900bce7ed 100644 --- a/doc/devel/contribute.rst +++ b/doc/devel/contribute.rst @@ -2,9 +2,10 @@ .. _contributing: -********** -Contribute -********** +****************** +Contributing guide +****************** + You've discovered a bug or something else you want to change in Matplotlib — excellent! @@ -13,10 +14,6 @@ You've worked out a way to fix it — even better! You want to tell us about it — best of all! -This project is a community effort, and everyone is welcome to contribute. Everyone -within the community is expected to abide by our `code of conduct -`_. - Below, you can find a number of ways to contribute, and how to connect with the Matplotlib community. @@ -275,7 +272,7 @@ repository `__ on GitHub, then submit a "pull request" (PR). You can do this by cloning a copy of the Maplotlib repository to your own computer, or alternatively using `GitHub Codespaces `_, a cloud-based -in-browser development environment that comes with the appropriated setup to +in-browser development environment that comes with the appropriate setup to contribute to Matplotlib. Workflow overview diff --git a/doc/devel/index.rst b/doc/devel/index.rst index 9744d757c342..672f2ce9f9d9 100644 --- a/doc/devel/index.rst +++ b/doc/devel/index.rst @@ -16,13 +16,27 @@ Contribute :octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve Matplotlib! :octicon:`heart;1em;sd-text-info` -There are various ways to contribute: optimizing and refactoring code, detailing -unclear documentation and writing new examples, helping the community, reporting -and fixing bugs and requesting and implementing new features... +This project is a community effort, and everyone is welcome to contribute. Everyone +within the community is expected to abide by our :ref:`code of conduct `. + +There are various ways to contribute, such as optimizing and refactoring code, +detailing unclear documentation and writing new examples, helping the community, +reporting and fixing bugs, requesting and implementing new features... .. _submitting-a-bug-report: .. _request-a-new-feature: +GitHub issue tracker +==================== + +The `issue tracker `_ serves as the +centralized location for making feature requests, reporting bugs, identifying major +projects to work on, and discussing priorities. + +We have preloaded the issue creation page with markdown forms requesting the information +we need to triage issues and we welcome you to add any additional information or +context that may be necessary for resolving the issue: + .. grid:: 1 1 2 2 .. grid-item-card:: @@ -31,9 +45,7 @@ and fixing bugs and requesting and implementing new features... :octicon:`bug;1em;sd-text-info` **Submit a bug report** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - We have preloaded the issue creation page with a Markdown form that you can - use to provide relevant context. Thank you for your help in keeping bug reports - complete, targeted and descriptive. + Thank you for your help in keeping bug reports targeted and descriptive. .. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose :expand: @@ -47,9 +59,7 @@ and fixing bugs and requesting and implementing new features... :octicon:`light-bulb;1em;sd-text-info` **Request a new feature** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - We will give feedback on the feature proposal. Since - Matplotlib is an open source project with limited resources, we encourage - users to then also :ref:`participate in the implementation `. + Thank you for your help in keeping feature requests well defined and tightly scoped. .. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose :expand: @@ -57,17 +67,16 @@ and fixing bugs and requesting and implementing new features... Request a feature +Since Matplotlib is an open source project with limited resources, we encourage users +to also :ref:`participate ` in fixing bugs and implementing new +features. + +Contributing guide +================== We welcome you to get more involved with the Matplotlib project! If you are new to contributing, we recommend that you first read our -:ref:`contributing guide`. If you are contributing code or -documentation, please follow our guides for setting up and managing a -:ref:`development environment and workflow`. -For code, documentation, or triage, please follow the corresponding -:ref:`contribution guidelines `. - -New contributors -================ +:ref:`contributing guide`: .. toctree:: :hidden: @@ -115,13 +124,13 @@ New contributors :octicon:`globe;1em;sd-text-info` Build community - - - .. _development_environment: -Development environment -======================= +Development workflow +==================== + +If you are contributing code or documentation, please follow our guide for setting up +and managing a development environment and workflow: .. grid:: 1 1 2 2 @@ -159,6 +168,11 @@ Development environment Policies and guidelines ======================= +These policies and guidelines help us maintain consistency in the various types +of maintenance work. If you are writing code or documentation, following these policies +helps maintainers more easily review your work. If you are helping triage, community +manage, or release manage, these guidelines describe how our current process works. + .. grid:: 1 1 2 2 :class-row: sf-fs-1 :gutter: 2 diff --git a/doc/index.rst b/doc/index.rst index 1a385d2330af..dedd614985df 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -31,6 +31,7 @@ Install .. tab-item:: other + .. rst-class:: section-toc .. toctree:: :maxdepth: 2 @@ -106,6 +107,7 @@ Community .. grid-item:: + .. rst-class:: section-toc .. toctree:: :maxdepth: 2 @@ -144,11 +146,11 @@ Contribute .. grid-item:: - Matplotlib is a community project maintained for and by its users. - - There are many ways you can help! + Matplotlib is a community project maintained for and by its users. See + :ref:`developers-guide-index` for the many ways you can help! .. grid-item:: + .. rst-class:: section-toc .. toctree:: :maxdepth: 2 @@ -168,7 +170,7 @@ About us and hard things possible. .. grid-item:: - + .. rst-class:: section-toc .. toctree:: :maxdepth: 2