You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+20-34Lines changed: 20 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -127,74 +127,60 @@ license your work under the terms of the [Apache 2.0 License](../LICENSE).
127
127
128
128
## Code guidelines
129
129
130
-
### Python
130
+
We use [`uv`](https://docs.astral.sh/uv/) to manage the Python project, and [`just`](https://github.com/casey/just) as a task runner. See their resepctive documentation for details on how to install. To manage the JavaScript package you will also need to install [NodeJS](https://nodejs.org/)
131
131
132
-
We use [`nox`](https://nox.thea.codes/en/stable/) to test and lint Python code.
132
+
Python code is linted using `ruff`, JavaScript code is linted using `prettier`. Run the linters with
133
133
134
134
```sh
135
-
pip install nox
135
+
just lint
136
136
```
137
137
138
-
Code is linted using `black`, `flake8`, and `isort`. Run the linters with
138
+
You can alternatively lint just the Python or JavaScript source with
139
139
140
140
```sh
141
-
nox -s lint
141
+
just lint-py
142
+
just lint-js
142
143
```
143
144
144
-
Many formatting issues can be fixed automatically by `black` and `isort`. Run
145
-
them with
145
+
Many formatting issues can be fixed automatically by `ruff` or `prettier` respectively. Run them with
146
146
147
147
```sh
148
-
nox -s format
148
+
just format
149
149
```
150
150
151
151
Finally you can run the Python tests locally for a particular version of Python
152
152
with
153
153
154
154
```sh
155
-
nox -s test-3.8
155
+
just python_version=3.10 test-py
156
156
```
157
157
158
-
and similarly for other versions.
158
+
and similarly for other versions. Run the JavaScript unit tests with
159
159
160
-
### JS
161
-
162
-
Prettier to format JavaScript code as configured in `.prettierrc`. You can lint
163
-
your code with
164
-
165
-
```bash
166
-
npm run lint
160
+
```sh
161
+
npm test
162
+
# or
163
+
just test-js
167
164
```
168
165
169
-
and format it automatically with
166
+
Run all tests with
170
167
171
-
```bash
172
-
npm run format
168
+
```sh
169
+
just test
173
170
```
174
171
175
-
### Run tests
176
-
177
-
Run `npm run test` before committing to ensure your changes pass our tests.
178
-
179
172
## Building dash-bootstrap-components locally
180
173
181
-
To build _dash-bootstrap-components_ locally, first install the Python
182
-
development dependencies
183
-
184
-
```sh
185
-
python -m pip install -r requirements-dev.txt
186
-
```
187
-
188
-
Then install JavaScript dependencies
174
+
First install JavaScript dependencies
189
175
190
176
```sh
191
177
npm install
192
178
```
193
179
194
-
You can now build Python, R and Julia packages with
0 commit comments