Skip to content

Commit de439a3

Browse files
story645timhoffm
andcommitted
explain that gfi is for training, add no AI policy,
move difficulty under issues [ci doc] Co-authored-by: Tim Hoffmann <[email protected]>
1 parent 60dd2e2 commit de439a3

2 files changed

Lines changed: 24 additions & 22 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 not 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: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -203,10 +203,6 @@ result is not of value to the project. To preserve precious core developer
203203
capacity, we reserve the right to rigorously reject seemingly AI generated
204204
low-value contributions.
205205

206-
In particular, it is also strictly forbidden to post AI generated
207-
content to issues or PRs via automated tooling such as bots or agents. We
208-
may ban such users and/or report them to GitHub.
209-
210206
.. _new_contributors:
211207

212208
New contributors
@@ -260,23 +256,14 @@ To join, please go to our public `community gitter`_ channel, and ask to be adde
260256
Good first issues
261257
-----------------
262258

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.
259+
We have marked some issues as `good first issue
260+
<https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_ because we
261+
think they are a good entry point into the process of contributing to Matplotlib. These
262+
issues are well documented, do not require a deep understanding of the internals of
263+
Matplotlib, and do not need urgent resolution. Pull requests that are :ref:`AI generated <generative_ai>`
264+
will be closed because good first issues are intended to onboard newcomers with a
265+
genuine interest in improving Matplotlib in the hopes they will continue to participate
266+
in our development community.
280267

281268
.. _first_contribution:
282269

@@ -334,6 +321,21 @@ a new PR; duplicate PRs are subject to being closed. However, if the existing
334321
PR is an outline, unlikely to work, or stalled, and the original author is
335322
unresponsive, feel free to open a new PR referencing the old one.
336323

324+
Difficulty
325+
----------
326+
Issues may additionally be tagged with a difficulty. ``Difficulty: Easy`` is suited
327+
for people with little Python experience. ``Difficulty: Medium`` and
328+
``Difficulty: Hard`` require more programming experience. This could be for a variety of
329+
reasons, among them, e.g.:
330+
331+
- requires understanding intermediate to advanced Python features, such as decorators,
332+
context managers, or meta-programming
333+
- is in areas of the code base which have more interdependencies or is legacy code.
334+
- involves complex or significant changes to algorithms or architecture.
335+
336+
Generally, the difficulty level is correlated with how much conceptual (and contextual)
337+
understanding of Matplotlib is required to resolve it.
338+
337339
.. _how-to-pull-request:
338340

339341
Start a pull request

0 commit comments

Comments
 (0)