twisted / twisted/twisted

Contributor documentation: black-reformat → lint

Open Beginner friendly
#10,127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug new priority-normal website
Dominant language
Python
Stars
6k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
10

Description

Gallaecio's avatar @Gallaecio reported
Trac ID trac#10127
Type defect
Created 2021-03-12 14:50:57Z

https://twistedmatrix.com/trac/wiki/TwistedDevelopment suggests running

tox -e black-reformat

I think the current approach is:

tox -e link
Searchable metadata
trac-id__10127 10127
type__defect defect
reporter__Gallaecio Gallaecio
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__new new
resolution__None None
component__website website
keywords__None None
time__1615560657357404 1615560657357404
changetime__1615560657357404 1615560657357404
version__None None
owner__None None

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the TwistedDevelopment wiki page linked in the issue and inspect the contributor formatting instructions. Compare the documented tox -e black-reformat command with the current tox -e link approach, then update the documentation so it names the current command and verify the resulting page text.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.