Link issue tracker in contributing docs #5688

konstin · 2023-07-11T13:45:18Z

Summary

This adds links to issue categories that are good for people looking to implement something and a link to the contributing guide feedback issue (#5684)

github-actions · 2023-07-11T13:55:53Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.01      8.0±0.01ms     5.1 MB/sec    1.00      7.9±0.02ms     5.2 MB/sec
formatter/numpy/ctypeslib.py               1.00   1849.2±1.84µs     9.0 MB/sec    1.00   1856.7±6.68µs     9.0 MB/sec
formatter/numpy/globals.py                 1.00    207.5±0.69µs    14.2 MB/sec    1.01   210.1±15.26µs    14.0 MB/sec
formatter/pydantic/types.py                1.00      4.0±0.06ms     6.4 MB/sec    1.00      4.0±0.02ms     6.4 MB/sec
linter/all-rules/large/dataset.py          1.00     13.4±0.02ms     3.0 MB/sec    1.00     13.3±0.02ms     3.0 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.4±0.01ms     5.0 MB/sec    1.01      3.4±0.01ms     4.9 MB/sec
linter/all-rules/numpy/globals.py          1.00    428.5±0.42µs     6.9 MB/sec    1.01    431.7±0.87µs     6.8 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.0±0.01ms     4.3 MB/sec    1.01      6.0±0.01ms     4.3 MB/sec
linter/default-rules/large/dataset.py      1.00      6.7±0.01ms     6.1 MB/sec    1.01      6.7±0.01ms     6.1 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1448.1±2.99µs    11.5 MB/sec    1.02   1474.1±3.07µs    11.3 MB/sec
linter/default-rules/numpy/globals.py      1.00    165.7±0.77µs    17.8 MB/sec    1.02    168.7±0.33µs    17.5 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.0±0.01ms     8.5 MB/sec    1.01      3.0±0.01ms     8.4 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.01      9.5±0.04ms     4.3 MB/sec    1.00      9.4±0.03ms     4.3 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.1±0.01ms     7.9 MB/sec    1.01      2.1±0.01ms     7.9 MB/sec
formatter/numpy/globals.py                 1.00    228.4±1.62µs    12.9 MB/sec    1.00    229.4±7.21µs    12.9 MB/sec
formatter/pydantic/types.py                1.00      4.7±0.02ms     5.4 MB/sec    1.00      4.7±0.03ms     5.4 MB/sec
linter/all-rules/large/dataset.py          1.01     15.7±0.11ms     2.6 MB/sec    1.00     15.6±0.06ms     2.6 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.1±0.02ms     4.0 MB/sec    1.00      4.1±0.02ms     4.0 MB/sec
linter/all-rules/numpy/globals.py          1.01    426.7±4.90µs     6.9 MB/sec    1.00    423.8±4.74µs     7.0 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.1±0.05ms     3.6 MB/sec    1.00      7.1±0.09ms     3.6 MB/sec
linter/default-rules/large/dataset.py      1.01      8.1±0.05ms     5.0 MB/sec    1.00      8.0±0.04ms     5.1 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1653.2±9.62µs    10.1 MB/sec    1.00  1647.3±25.61µs    10.1 MB/sec
linter/default-rules/numpy/globals.py      1.01    180.1±1.17µs    16.4 MB/sec    1.00    177.7±1.86µs    16.6 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.6±0.02ms     7.0 MB/sec    1.00      3.6±0.02ms     7.1 MB/sec

CONTRIBUTING.md

zanieb · 2023-07-11T23:51:33Z

CONTRIBUTING.md

@@ -34,6 +36,8 @@ As a concrete example: consider taking on one of the rules from the [`flake8-pyi
 plugin, and looking to the originating [Python source](https://github.com/PyCQA/flake8-pyi) for
 guidance.

+If there is something missing in the contributing docs, please comment [here](https://github.com/astral-sh/ruff/issues/5684)!


Moved to a discussion right?

yep, updated

## Summary This adds links to issue categories that are good for people looking to implement something and a link to the contributing guide feedback issue (#5684)

konstin · 2023-07-12T13:33:18Z

Current dependencies on/for this PR:

main
- PR Document ruff_dev and format_dev #5648
  - PR Link issue tracker in contributing docs #5688 👈
    - PR Update ruff crate descriptions #5710

This comment was auto-generated by Graphite.

Co-authored-by: Zanie <contact@zanie.dev>

charliermarsh · 2023-07-12T20:22:59Z

(Disregard deleted comment, I can work around for now.)

charliermarsh · 2023-07-12T20:49:25Z

CONTRIBUTING.md

@@ -34,6 +36,8 @@ As a concrete example: consider taking on one of the rules from the [`flake8-pyi
 plugin, and looking to the originating [Python source](https://github.com/PyCQA/flake8-pyi) for
 guidance.

+If there is something missing in the contributing docs, please comment [here](https://github.com/astral-sh/ruff/discussions/5693)!


I'd probably write something corny like: "If you have suggestions on how we might improve the contributing documentation, let us know!"

charliermarsh

LGTM, thanks.

## Summary This adds links to issue categories that are good for people looking to implement something and a link to the contributing guide feedback issue (#5684) --------- Co-authored-by: Zanie <contact@zanie.dev>

konstin added the internal An internal refactor or improvement label Jul 11, 2023

zanieb reviewed Jul 11, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

zanieb reviewed Jul 11, 2023

View reviewed changes

konstin added 5 commits July 12, 2023 15:32

Document ruff_dev and format_dev

b95bf29

End rust docstrings with a dot

b792dfc

End rust docstrings with a dot

868561b

Remove link not in docs

f3cf430

Link issue tracker in contributing docs

2efef23

## Summary This adds links to issue categories that are good for people looking to implement something and a link to the contributing guide feedback issue (#5684)

konstin changed the base branch from main to docs July 12, 2023 13:33

konstin force-pushed the add_issue_tracker_links_to_contributing_docs branch from 7794f66 to 2efef23 Compare July 12, 2023 13:33

konstin mentioned this pull request Jul 12, 2023

Document ruff_dev and format_dev #5648

Merged

konstin mentioned this pull request Jul 12, 2023

Update ruff crate descriptions #5710

Merged

Base automatically changed from docs to main July 12, 2023 14:18

konstin and others added 2 commits July 12, 2023 16:18

Update CONTRIBUTING.md

79f4aa4

Co-authored-by: Zanie <contact@zanie.dev>

review

489df49

charliermarsh approved these changes Jul 12, 2023

View reviewed changes

charliermarsh reviewed Jul 12, 2023

View reviewed changes

Review

0becfca

konstin enabled auto-merge (squash) July 13, 2023 10:35

konstin merged commit b1781ab into main Jul 13, 2023

konstin deleted the add_issue_tracker_links_to_contributing_docs branch July 13, 2023 10:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Link issue tracker in contributing docs #5688

Link issue tracker in contributing docs #5688

konstin commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 •

edited

Loading

zanieb Jul 11, 2023

konstin Jul 12, 2023

konstin commented Jul 12, 2023

charliermarsh commented Jul 12, 2023

charliermarsh Jul 12, 2023

konstin Jul 13, 2023

charliermarsh left a comment

Link issue tracker in contributing docs #5688

Link issue tracker in contributing docs #5688

Conversation

konstin commented Jul 11, 2023

Summary

github-actions bot commented Jul 11, 2023 • edited Loading

PR Check Results

Ecosystem

Benchmark

Linux

Windows

zanieb Jul 11, 2023

Choose a reason for hiding this comment

konstin Jul 12, 2023

Choose a reason for hiding this comment

konstin commented Jul 12, 2023

charliermarsh commented Jul 12, 2023

charliermarsh Jul 12, 2023

Choose a reason for hiding this comment

konstin Jul 13, 2023

Choose a reason for hiding this comment

charliermarsh left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 11, 2023 •

edited

Loading