Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6dbc0c7

Browse files
timhoffmrcomer
andauthored
explain that gfi is for training, add no AI policy, (#31142)
move difficulty under issues [ci doc] Co-authored-by: Tim Hoffmann <[email protected]> Co-authored-by: Ruth Comer <[email protected]>
2 parents 16b6efa + b860107 commit 6dbc0c7

2 files changed

Lines changed: 25 additions & 18 deletions

File tree

.github/workflows/good-first-issue.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
### Good first issue - notes for new contributors
2020
2121
This issue is suited to new contributors because it does not require
22-
understanding of the Matplotlib internals. This is a low priority task
22+
understanding of the Matplotlib internals. This is a non-urgent task
2323
intended for human contributors to learn how to contribute; therefore please
2424
do not try to automate a solution using AI. To get started, please see our
2525
[contributing guide](https://matplotlib.org/stable/devel/index).

doc/devel/contribute.rst

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -260,23 +260,14 @@ To join, please go to our public `community gitter`_ channel, and ask to be adde
260260
Good first issues
261261
-----------------
262262

263-
While any contributions are welcome, we have marked some issues as
264-
particularly suited for new contributors by the label `good first issue
265-
<https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_. These
266-
are well documented issues, that do not require a deep understanding of the
267-
internals of Matplotlib. The issues may additionally be tagged with a
268-
difficulty. ``Difficulty: Easy`` is suited for people with little Python
269-
experience. ``Difficulty: Medium`` and ``Difficulty: Hard`` require more
270-
programming experience. This could be for a variety of reasons, among them,
271-
though not necessarily all at the same time:
272-
273-
- The issue is in areas of the code base which have more interdependencies,
274-
or legacy code.
275-
- It has less clearly defined tasks, which require some independent
276-
exploration, making suggestions, or follow-up discussions to clarify a good
277-
path to resolve the issue.
278-
- It involves Python features such as decorators and context managers, which
279-
have subtleties due to our implementation decisions.
263+
We have marked some issues as `good first issue
264+
<https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_ because we
265+
think they are a good entry point into the process of contributing to Matplotlib. These
266+
issues are well documented, do not require a deep understanding of the internals of
267+
Matplotlib, and do not need urgent resolution. Good first issues are intended to onboard
268+
newcomers with a genuine interest in improving Matplotlib, in the hopes that they will
269+
continue to participate in our development community; therefore, pull requests that are
270+
:ref:`AI generated <generative_ai>` will be closed.
280271

281272
.. _first_contribution:
282273

@@ -334,6 +325,22 @@ a new PR; duplicate PRs are subject to being closed. However, if the existing
334325
PR is an outline, unlikely to work, or stalled, and the original author is
335326
unresponsive, feel free to open a new PR referencing the old one.
336327

328+
Difficulty
329+
----------
330+
Issues may additionally be tagged with a difficulty. ``Difficulty: Easy`` is suitable
331+
for people with beginner scientific Python experience, i.e. fluency with Python syntax
332+
and some experience using libraries like Numpy, Pandas, or Xarray. ``Difficulty: Medium``
333+
and ``Difficulty: Hard`` require more programming experience. This could be for a variety
334+
of reasons, for example:
335+
336+
- requires understanding intermediate to advanced Python features, such as decorators,
337+
context managers, or meta-programming
338+
- is in areas of the code base which have more interdependencies or is legacy code.
339+
- involves complex or significant changes to algorithms or architecture.
340+
341+
Generally, the difficulty level is correlated with how much conceptual (and contextual)
342+
understanding of Matplotlib is required to resolve it.
343+
337344
.. _how-to-pull-request:
338345

339346
Start a pull request

0 commit comments

Comments
 (0)