1
1
# Contributing
2
2
3
3
## Report Bugs and Submit Feedback
4
+
4
5
Report bugs at https://github.com/yt-project/jupyter_libyt/issues .
5
6
6
7
If you are reporting a bug, please include:
7
8
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.
11
12
12
13
If you are proposing a feature:
13
14
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
17
18
are welcome :)
18
19
19
20
## Setting Up Development Environment
@@ -22,67 +23,80 @@ If you are proposing a feature:
22
23
23
24
1 . Fork the ` jupyter_libyt ` repo on GitHub.
24
25
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
+
28
31
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
+ ```
32
36
33
37
### Using ` tox ` to Test, Do Code-Formatting, and Linting
34
38
35
39
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/ ) )
41
46
42
47
#### Python Unit test
48
+
43
49
``` bash
44
50
tox
45
51
```
46
52
47
53
#### Converting Old String to F-String
54
+
48
55
``` bash
49
56
tox -e fstring
50
57
```
51
58
52
59
#### Code Formatting
60
+
53
61
``` bash
54
62
tox -e format
55
63
```
56
64
57
65
#### Sort Import Order
66
+
58
67
``` bash
59
68
tox -e sort_import
60
69
```
61
70
62
71
#### Linting
72
+
63
73
``` bash
64
74
tox -e lint
65
75
```
66
76
67
77
### Pre-Commit
68
78
69
79
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/ ) )
74
85
75
86
Set up pre-commit for the first time:
87
+
76
88
``` bash
77
89
pre-commit install
78
90
```
79
91
80
92
Check every file:
93
+
81
94
``` bash
82
95
pre-commit run --all-files
83
96
```
84
97
85
98
Commit your changes and push your branch to GitHub, pre-commit will apply to staged files before committing:
99
+
86
100
``` bash
87
101
git add .
88
102
git commit -m " Your detailed description of your changes."
0 commit comments