Opened 3 weeks ago

Last modified 3 weeks ago

#37335 assigned Cleanup/optimization

Clarify contributing tutorial and add Windows command examples

Reported by: Vandna Owned by: Vandna
Component: Documentation Version: dev
Severity: Normal Keywords: docs windows tutorial
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The "Writing your first contribution" tutorial (docs/intro/contributing.txt) has some unclear wording in places, and several sections only show macOS/Linux commands (e.g. venv creation, running the test suite) without Windows equivalents. This ticket proposes clarifying the prose and adding the missing Windows commands alongside the existing ones, consistent with the pattern already used elsewhere in the doc.

Change History (9)

comment:1 by VIZZARD-X, 3 weeks ago

Hello Vandna, the docs have proven to be well structured and don't appear to be muddled. It would be useful to include/highlight the passage that feels unclear in your ticket to give contributors a better understanding. As far as commands are concerned, a toggle between macOS/Linux and Windows has been provided for most of the commands. To activate the venv as documented in the tutorial, Windows users should use:

%HOMEPATH%\.virtualenvs\djangodev\Scripts\activate.bat
Version 0, edited 3 weeks ago by VIZZARD-X (next)

comment:2 by Jonathan Biemond, 3 weeks ago

Triage Stage: Unreviewed → Accepted
Version: 6.1 → dev

Thanks Vandna, there is plenty of room for improving the wording. Regarding missing commands for on Windows, I didn't notice any, so just do a double check on your end. If you are working on a PR, please set yourself as the owner.

There's been some discussion on the forum around this page and others that might be really helpful.
​https://forum.djangoproject.com/t/public-notes-on-first-contribution-instructions-maybe-ideas-for-some-new-contributor-opportunities/45374

I've even written up some changes myself. Please use as much or as little from there as you like.
​https://github.com/django/django/compare/main...jonbiemond:django:docs/writing-your-first-contribution

comment:3 by Vandna, 3 weeks ago

Owner: set to Vandna
Status: new → assigned

comment:4 by Vandna, 3 weeks ago

Has patch: set

comment:6 by Jonathan Biemond, 3 weeks ago

Patch needs improvement: set

comment:7 by Vandna, 3 weeks ago

Patch needs improvement: unset

Removed the duplicate Windows admonitions and fixed the line-length lint

error per review feedback.

comment:8 by Jonathan Biemond, 3 weeks ago

Patch needs improvement: set

comment:9 by Jonathan Biemond, 3 weeks ago

Patch needs improvement: unset
Note: See TracTickets for help on using tickets.
Back to Top