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: README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,6 +44,7 @@
44
44
45
45
This project is following the standard **Git Feature Workflow** development model. Learn about all the various steps of the development workflow, from creating a fork to submitting a pull request, in the [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md) guide.
46
46
47
+
> [!TIP]
47
48
> Make sure to read the [Styleguides](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md#styleguides) section to ensure a cohesive code format across the project.
48
49
49
50
You can submit bug reports, enhancement and new feature requests in the [discussions](https://github.com/ietf-tools/datatracker/discussions) area. Accepted tickets will be converted to issues.
@@ -52,7 +53,8 @@ You can submit bug reports, enhancement and new feature requests in the [discuss
52
53
53
54
Click the <kbd>Fork</kbd> button in the top-right corner of the repository to create a personal copy that you can work on.
54
55
55
-
> Note that some GitHub Actions might be enabled by default in your fork. You should disable them by going to **Settings** > **Actions** > **General** and selecting **Disable actions** (then Save).
56
+
> [!NOTE]
57
+
> Some GitHub Actions might be enabled by default in your fork. You should disable them by going to **Settings** > **Actions** > **General** and selecting **Disable actions** (then Save).
56
58
57
59
#### Git Cloning Tips
58
60
@@ -104,7 +106,8 @@ Read the [Docker Dev Environment](docker/README.md) guide to get started.
104
106
105
107
Nightly database dumps of the datatracker are available as Docker images: `ghcr.io/ietf-tools/datatracker-db:latest`
106
108
107
-
> Note that to update the database in your dev environment to the latest version, you should run the `docker/cleandb` script.
109
+
> [!TIP]
110
+
> In order to update the database in your dev environment to the latest version, you should run the `docker/cleandb` script.
108
111
109
112
### Blob storage for dev/test
110
113
@@ -248,6 +251,7 @@ From a datatracker container, run the command:
248
251
./ietf/manage.py test --settings=settings_test
249
252
```
250
253
254
+
> [!TIP]
251
255
> You can limit the run to specific tests using the `--pattern` argument.
252
256
253
257
### Frontend Tests
@@ -257,11 +261,13 @@ Frontend tests are done via Playwright. There're 2 different type of tests:
257
261
- Tests that test Vue pages / components and run natively without any external dependency.
258
262
- Tests that require a running datatracker instance to test against (usually legacy views).
259
263
264
+
> [!IMPORTANT]
260
265
> Make sure you have Node.js 16.x or later installed on your machine.
261
266
262
267
#### Run Vue Tests
263
268
264
-
> :warning: All commands below **MUST** be run from the `./playwright` directory, unless noted otherwise.
269
+
> [!WARNING]
270
+
> All commands below **MUST** be run from the `./playwright` directory, unless noted otherwise.
265
271
266
272
1. Run **once** to install dependencies on your system:
267
273
```sh
@@ -294,7 +300,8 @@ Frontend tests are done via Playwright. There're 2 different type of tests:
294
300
295
301
First, you need to start a datatracker instance (dev or prod), ideally from a docker container, exposing the 8000 port.
296
302
297
-
> :warning: All commands below **MUST** be run from the `./playwright` directory.
303
+
> [!WARNING]
304
+
> All commands below **MUST** be run from the `./playwright` directory.
298
305
299
306
1. Run **once** to install dependencies on your system:
0 commit comments