Opened 2 months ago

Closed 2 months ago

#37229 closed Cleanup/optimization (worksforme)

The Readme is "disorganized"

Reported by: DomeniGeco Owned by:
Component: Documentation Version: 6.0
Severity: Normal Keywords: readme
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by DomeniGeco)

The README off Django is a little disorganized.
A possible fix is in PR #21665.

​https://github.com/django/django/pull/21665

Change History (4)

comment:1 by DomeniGeco, 2 months ago

Description: modified (diff)

comment:2 by DomeniGeco, 2 months ago

Triage Stage: Unreviewed → Accepted

in reply to:  2 comment:3 by Natalia Bidart, 2 months ago

Component: Uncategorized → Documentation
Triage Stage: Accepted → Unreviewed
Type: Uncategorized → Cleanup/optimization

Replying to DeMENIGECO:

Hi, thank you for your ticket, but please do not accept your own tickets. A different contributor should triage it. The goal is to delay PR submission until the issue is confirmed valid and accepted.

comment:4 by Natalia Bidart, 2 months ago

Resolution: → worksforme
Status: new → closed

I invested some time into looking in the closed PRs. On the changes: the logo is a DSF branding decision, not something settled in a README pull request; the documentation paragraph is already correct, and the proposed list is less grammatical since the second item begins with "and"; and the tutorial link duplicates the one above it, points at /en/stable/ rather than /en/dev/, and reads "an tutorial".

More importantly, every change carries a cost that is invisible from outside: review, discussion, style checks, backport consideration, and a permanent place in the history. That cost is much the same whether a diff is three lines or three hundred, so the value has to exceed it. Edits to prose that is already clear do not clear that bar, and they consume review time that would otherwise go to bugs affecting users.

I would also gently push back on the idea that small cosmetic changes make a good first contribution. For where to start, please see ​https://docs.djangoproject.com/en/dev/internals/contributing/.

For the reasons above, I am closing this ticket and declining the pull request. Thanks again!

Note: See TracTickets for help on using tickets.
Back to Top