Skip to content

Commit 65db261

Browse files
committed
Run jlpm prettier.
1 parent 3ef7745 commit 65db261

File tree

4 files changed

+44
-32
lines changed

4 files changed

+44
-32
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
* jupyter_libyt version:
2-
* libyt version:
3-
* Python version:
4-
* Operating System:
1+
- jupyter_libyt version:
2+
- libyt version:
3+
- Python version:
4+
- Operating System:
55

66
### Summary
77

@@ -23,5 +23,3 @@ If there was a crash, please include the traceback here.
2323
```
2424

2525
#### Expected Outcome
26-
27-

AUTHORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
## Contributors
22

3-
* Shin-Rong Tsai <[email protected]>
3+
- Shin-Rong Tsai <[email protected]>

CONTRIBUTING.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# Contributing
22

33
## Report Bugs and Submit Feedback
4+
45
Report bugs at https://github.com/yt-project/jupyter_libyt/issues.
56

67
If you are reporting a bug, please include:
78

8-
* Your operating system name and version.
9-
* Any details about your local setup that might be helpful in troubleshooting.
10-
* Detailed steps to reproduce the bug.
9+
- Your operating system name and version.
10+
- Any details about your local setup that might be helpful in troubleshooting.
11+
- Detailed steps to reproduce the bug.
1112

1213
If you are proposing a feature:
1314

14-
* Explain in detail how it would work.
15-
* Keep the scope as narrow as possible, to make it easier to implement.
16-
* Remember that this is a volunteer-driven project, and that contributions
15+
- Explain in detail how it would work.
16+
- Keep the scope as narrow as possible, to make it easier to implement.
17+
- Remember that this is a volunteer-driven project, and that contributions
1718
are welcome :)
1819

1920
## Setting Up Development Environment
@@ -22,67 +23,80 @@ If you are proposing a feature:
2223

2324
1. Fork the `jupyter_libyt` repo on GitHub.
2425
2. Clone your fork locally:
25-
```bash
26-
git clone https://github.com/<your-github-account>/jupyter_libyt.git
27-
```
26+
27+
```bash
28+
git clone https://github.com/<your-github-account>/jupyter_libyt.git
29+
```
30+
2831
3. Create a branch for local development:
29-
```bash
30-
git checkout -b name-of-your-bugfix-or-feature
31-
```
32+
33+
```bash
34+
git checkout -b name-of-your-bugfix-or-feature
35+
```
3236

3337
### Using `tox` to Test, Do Code-Formatting, and Linting
3438

3539
We use [`tox`](https://tox.wiki/en/4.11.3/installation.html) to run:
36-
- Python unit test ([`pytest`](https://docs.pytest.org/en/7.4.x/))
37-
- Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
38-
- Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
39-
- Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
40-
- Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
40+
41+
- Python unit test ([`pytest`](https://docs.pytest.org/en/7.4.x/))
42+
- Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
43+
- Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
44+
- Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
45+
- Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
4146

4247
#### Python Unit test
48+
4349
```bash
4450
tox
4551
```
4652

4753
#### Converting Old String to F-String
54+
4855
```bash
4956
tox -e fstring
5057
```
5158

5259
#### Code Formatting
60+
5361
```bash
5462
tox -e format
5563
```
5664

5765
#### Sort Import Order
66+
5867
```bash
5968
tox -e sort_import
6069
```
6170

6271
#### Linting
72+
6373
```bash
6474
tox -e lint
6575
```
6676

6777
### Pre-Commit
6878

6979
We use [pre-commit](https://pre-commit.com/#install) to check code format and style before committing:
70-
- Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
71-
- Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
72-
- Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
73-
- Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
80+
81+
- Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
82+
- Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
83+
- Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
84+
- Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
7485

7586
Set up pre-commit for the first time:
87+
7688
```bash
7789
pre-commit install
7890
```
7991

8092
Check every file:
93+
8194
```bash
8295
pre-commit run --all-files
8396
```
8497

8598
Commit your changes and push your branch to GitHub, pre-commit will apply to staged files before committing:
99+
86100
```bash
87101
git add .
88102
git commit -m "Your detailed description of your changes."

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
This is a Jupyter provisioner for [`libyt`](https://github.com/yt-project/libyt) kernel.
66

7-
* **Jupyter Project**: https://jupyter.org/
8-
* **yt**: https://yt-project.org/
9-
* **libyt Repo**: https://github.com/yt-project/libyt
10-
* **libyt Doc**: https://libyt.readthedocs.io/en/latest/
7+
- **Jupyter Project**: https://jupyter.org/
8+
- **yt**: https://yt-project.org/
9+
- **libyt Repo**: https://github.com/yt-project/libyt
10+
- **libyt Doc**: https://libyt.readthedocs.io/en/latest/
1111

1212
### Install
1313

0 commit comments

Comments
 (0)