Skip to content

Commit b864995

Browse files
committed
[docs] Contributing guidelines: how to select valid issues
1 parent 78cdfb2 commit b864995

2 files changed

Lines changed: 41 additions & 15 deletions

File tree

developer/contributing.rst

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@ We are glad and thankful that you want to contribute to OpenWISP.
55

66
.. warning::
77

8-
Contributions which shift the burden of understanding, implementation,
9-
testing, and review entirely onto maintainers are not acceptable. This
10-
includes abusing AI tools to generate pull requests which the
11-
contributor does not fully understand, explain, maintain, and test.
12-
Please read the :ref:`Anti AI Spam Policy <anti_spam_policy>` before
13-
opening a pull request.
8+
AI assisted contributions which shift the burden of understanding,
9+
implementation, testing, and review entirely onto maintainers are not
10+
acceptable. Please read the :ref:`Anti AI Spam Policy
11+
<anti_spam_policy>` before opening a pull request.
1412

1513
**Table of Contents:**
1614

@@ -29,6 +27,8 @@ use `the development channel
2927
channels share feedback, share your OpenWISP derivative work, ask
3028
questions or announce your intentions.
3129

30+
.. _openwisp_look_for_open_issues:
31+
3232
Look for open issues
3333
--------------------
3434

@@ -46,8 +46,22 @@ If there's anything you don't understand regarding the board or a specific
4646
github issue, don't hesitate to ask questions in our `dev channel
4747
<https://matrix.to/#/#openwisp_development:gitter.im>`_.
4848

49-
**You don't need to wait for the issue to be assigned to you.** Just check
50-
if there is anyone else actively working on it (e.g.: an open pull request
49+
New or occasional contributors must verify that **the issue has been
50+
validated by maintainers** before opening a pull request.
51+
52+
This also applies to issues you opened yourself: **wait until a maintainer
53+
has acknowledged and validated the issue before opening a pull request for
54+
it**.
55+
56+
In OpenWISP, **an issue is considered validated when it has any issue
57+
label** except ``invalid`` or ``wontfix``.
58+
59+
**Some issues are not suited to beginners**. These are clearly marked with
60+
a prominent warning at the beginning and must be avoided by beginners.
61+
62+
**If the issue has already been validated by a maintainer, you don't need
63+
to wait for it to be assigned to you before working on it.** Just check if
64+
there is anyone else actively working on it (e.g.: an open pull request
5165
with recent activity). If nobody else is actively working on it, **just
5266
announce your intention to work on it by leaving a comment in the issue**.
5367

general/code-of-conduct.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,33 @@ impact of their changes.
1515
Contributions which shift the burden of understanding, implementation,
1616
testing, and review entirely onto maintainers are harmful to the project.
1717
This includes AI abuse: using AI coding agents, chatbots, or other
18-
automation to generate pull requests without adequate human understanding,
19-
verification, and testing.
18+
automation to generate issues or pull requests without adequate human
19+
understanding, verification, and testing.
2020

2121
AI tools do not turn an inexperienced person into an experienced software
2222
developer. Contributors are responsible for understanding the project, the
2323
issue, and every change they submit. If a contributor cannot explain,
2424
maintain, and properly test the code they are proposing, they should not
2525
open a pull request.
2626

27-
Maintainers reserve the right to close pull requests considered spammy or
28-
harmful to the project, including but not limited to:
29-
27+
The same applies to issues. Opening AI-generated issues based on
28+
superficial code smells, automated scans, or generic suggestions without
29+
real project understanding or user impact creates noise and wastes
30+
maintainer time. Artificial workflows in which a contributor uses AI to
31+
find a minor or questionable issue, opens it, and immediately opens a pull
32+
request for it are considered spam when they provide little or no value to
33+
the project.
34+
35+
Maintainers reserve the right to close issues and pull requests considered
36+
spammy or harmful to the project, including but not limited to:
37+
38+
- issues generated by AI tools or automation without real user impact,
39+
project understanding, or meaningful investigation;
40+
- artificial issue-to-pull-request workflows created mainly to score
41+
contributions rather than solve a validated project need;
3042
- unsolicited pull requests which do not have a related issue;
3143
- pull requests targeting issues which have not been opened, acknowledged,
32-
validated, or accepted by maintainers;
44+
or :ref:`validated by maintainers <openwisp_look_for_open_issues>`;
3345
- pull requests with poor, incomplete, or untested implementations;
3446
- pull requests generated by AI tools or automation without enough human
3547
understanding, review, and testing;
@@ -45,5 +57,5 @@ Maintainers may temporarily limit contributions from contributors who
4557
violate this policy. Contributors who continue violating this policy after
4658
a temporary restriction may be banned permanently.
4759

48-
When a pull request or contribution is closed under this policy,
60+
When an issue, pull request, or contribution is closed under this policy,
4961
maintainers may provide only a link to this policy as the explanation.

0 commit comments

Comments
 (0)