Skip to content

Commit 59325de

Browse files
committed
docs: Slight tweaks to contributing guidelines
1 parent c5ce0f4 commit 59325de

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

CONTRIBUTING.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
# Contributing to `staged-script`
22

3-
> **Usage Guidelines:**
4-
>
5-
> * Review all the text and add/remove/adjust things as needed.
6-
> * Delete this note.
7-
83
Thanks so much for your willingness to help out with `staged-script`'s
94
development :grinning: Here's everything you need to know.
105

@@ -77,6 +72,7 @@ The checks we perform are the following:
7772
* Use [ruff][ruff] to lint and format the code and docstrings.
7873
* Use [mypy][mypy] to run static type checking on our type-hinted code.
7974
* Ensure no large files are added to the repository.
75+
* Ensure files parse as valid Python.
8076
* Check for files that would conflict in case-sensitive filesystems.
8177
* Ensure files don't contain merge conflict strings.
8278
* Ensure files end with a single blank line.
@@ -87,8 +83,6 @@ The checks we perform are the following:
8783
* Use [doc8][doc8] to enforce our style for our documentation.
8884
* Use [pyroma][pyroma] to ensure our package complies with the best practices
8985
of the Python packaging ecosystem.
90-
* INSERT OTHERS
91-
* AS NEEDED
9286

9387
[ruff]: https://docs.astral.sh/ruff/
9488
[mypy]: https://github.com/python/mypy
@@ -142,12 +136,12 @@ search for and install them. These are the ones we recommend:
142136
[GitKraken][kraken] into VS Code.
143137
* **IntelliCode:** AI-assisted development features.
144138
* **Pre-Commit:** Commands and helpers for executing pre-commit hooks.
139+
* **Test Adapter Converter:** Converts from the Test Explorer UI (below) API
140+
to native VS Code testing.
145141
* **Test Explorer UI:** Extensible user interface for running your tests in VS
146142
Code.
147143
* **Vim:** For when you can't truly leave vi behind (and who would want to?).
148144
* **vscode-icons:** Icons for the file explorer.
149-
* INSERT OTHERS
150-
* AS NEEDED
151145

152146
[conventional]: https://www.conventionalcommits.org/en/v1.0.0/
153147
[kraken]: https://www.gitkraken.com/

0 commit comments

Comments
 (0)