Fix nested lists in CONTRIBUTING.md (#5721)

## Summary

We have a lot of two-space-indented stuff, but apparently it needs to be
four-space indented to render as expected in MkDocs.
This commit is contained in:
Charlie Marsh 2023-07-13 12:32:59 -04:00 committed by GitHub
parent 5dd5ee0c5b
commit e7b059cc5c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 140 additions and 138 deletions

View file

@ -1,6 +1,10 @@
# default to true for all rules # default to true for all rules
default: true default: true
# MD007/unordered-list-indent
MD007:
indent: 4
# MD033/no-inline-html # MD033/no-inline-html
MD033: false MD033: false
@ -8,7 +12,4 @@ MD033: false
MD041: false MD041: false
# MD013/line-length # MD013/line-length
MD013: MD013: false
line_length: 100
code_blocks: false
ignore_code_blocks: true

View file

@ -22,6 +22,7 @@ repos:
hooks: hooks:
- id: mdformat - id: mdformat
additional_dependencies: additional_dependencies:
- mdformat-mkdocs
- mdformat-black - mdformat-black
- black==23.1.0 # Must be the latest version of Black - black==23.1.0 # Must be the latest version of Black

View file

@ -23,9 +23,10 @@ For small changes (e.g., bug fixes), feel free to submit a PR.
For larger changes (e.g., new lint rules, new functionality, new configuration options), consider For larger changes (e.g., new lint rules, new functionality, new configuration options), consider
creating an [**issue**](https://github.com/astral-sh/ruff/issues) outlining your proposed change. creating an [**issue**](https://github.com/astral-sh/ruff/issues) outlining your proposed change.
You can also join us on [**Discord**](https://discord.gg/c9MhzV8aU5) to discuss your idea with the You can also join us on [**Discord**](https://discord.gg/c9MhzV8aU5) to discuss your idea with the
community. We have labeled [beginner-friendly tasks in the issue tracker](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) community. We've labeled [beginner-friendly tasks](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
as well as [bugs](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and in the issue tracker, along with [bugs](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
[improvements that are ready for contributions](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Aaccepted). and [improvements](https://github.com/astral-sh/ruff/issues?q=is%3Aissue+is%3Aopen+label%3Aaccepted)
that are ready for contributions.
If you're looking for a place to start, we recommend implementing a new lint rule (see: If you're looking for a place to start, we recommend implementing a new lint rule (see:
[_Adding a new lint rule_](#example-adding-a-new-lint-rule), which will allow you to learn from and [_Adding a new lint rule_](#example-adding-a-new-lint-rule), which will allow you to learn from and
@ -289,17 +290,16 @@ even patch releases may contain [non-backwards-compatible changes](https://semve
main has your merged PR as last commit main has your merged PR as last commit
1. The release workflow will do the following: 1. The release workflow will do the following:
1. Build all the assets. If this fails (even though we tested in step 4), we havent tagged or 1. Build all the assets. If this fails (even though we tested in step 4), we havent tagged or
uploaded anything, you can restart after pushing a fix uploaded anything, you can restart after pushing a fix.
1. Upload to pypi 1. Upload to PyPI.
1. Create and push the git tag (from pyproject.toml). We create the git tag only here 1. Create and push the Git tag (as extracted from `pyproject.toml`). We create the Git tag only
because we can't change it ([#4468](https://github.com/charliermarsh/ruff/issues/4468)), so after building the wheels and uploading to PyPI, since we can't delete or modify the tag ([#4468](https://github.com/charliermarsh/ruff/issues/4468)).
we want to make sure everything up to and including publishing to pypi worked.
1. Attach artifacts to draft GitHub release 1. Attach artifacts to draft GitHub release
1. Trigger downstream repositories. This can fail without causing fallout, it is possible (if 1. Trigger downstream repositories. This can fail non-catastrophically, as we can run any
inconvenient) to trigger the downstream jobs manually downstream jobs manually if needed.
1. Create release notes in GitHub UI and promote from draft to proper release(<https://github.com/charliermarsh/ruff/releases/new>) 1. Create release notes in GitHub UI and promote from draft.
1. If needed, [update the schemastore](https://github.com/charliermarsh/ruff/blob/main/scripts/update_schemastore.py) 1. If needed, [update the schemastore](https://github.com/charliermarsh/ruff/blob/main/scripts/update_schemastore.py)
1. If needed, update ruff-lsp and ruff-vscode 1. If needed, update the `ruff-lsp` and `ruff-vscode` repositories.
## Ecosystem CI ## Ecosystem CI
@ -452,7 +452,7 @@ You can run the benchmarks with
cargo benchmark cargo benchmark
``` ```
#### Benchmark driven Development #### Benchmark-driven Development
Ruff uses [Criterion.rs](https://bheisler.github.io/criterion.rs/book/) for benchmarks. You can use Ruff uses [Criterion.rs](https://bheisler.github.io/criterion.rs/book/) for benchmarks. You can use
`--save-baseline=<name>` to store an initial baseline benchmark (e.g. on `main`) and then use `--save-baseline=<name>` to store an initial baseline benchmark (e.g. on `main`) and then use
@ -566,7 +566,7 @@ utils with it:
for start and stop of each node and also how the `:` token, the comment and whitespace are not for start and stop of each node and also how the `:` token, the comment and whitespace are not
represented anymore: represented anymore:
```text ````text
[ [
If( If(
StmtIf { StmtIf {
@ -591,7 +591,7 @@ utils with it:
}, },
), ),
] ]
``` ```
- `cargo dev print-tokens <file>`: Print the tokens that the AST is built upon. Again for - `cargo dev print-tokens <file>`: Print the tokens that the AST is built upon. Again for
`if True: pass # comment`: `if True: pass # comment`:
@ -605,7 +605,7 @@ utils with it:
"# comment", "# comment",
) 23 ) 23
23 Newline 24 23 Newline 24
``` ````
- `cargo dev print-cst <file>`: Print the CST of a python file using - `cargo dev print-cst <file>`: Print the CST of a python file using
[LibCST](https://github.com/Instagram/LibCST), which is used in addition to the RustPython parser [LibCST](https://github.com/Instagram/LibCST), which is used in addition to the RustPython parser