altf4arnold/datatracker
1
0
Fork 0
Code Issues Pull requests Actions 4 Packages Projects Releases Wiki Activity

docs: Update README.md

Browse source
This commit is contained in:
Nicolas Giard 2025-03-08 00:56:14 -05:00 committed by GitHub
parent 554182ef8a
commit cf6340443f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -44,6 +44,7 @@
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. 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.
> [!TIP]
> 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. > 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.
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. 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
Click the <kbd>Fork</kbd> button in the top-right corner of the repository to create a personal copy that you can work on. Click the <kbd>Fork</kbd> button in the top-right corner of the repository to create a personal copy that you can work on.
> 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). > [!NOTE]
> 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).
#### Git Cloning Tips #### Git Cloning Tips
@ -104,7 +106,8 @@ Read the [Docker Dev Environment](docker/README.md) guide to get started.
Nightly database dumps of the datatracker are available as Docker images: `ghcr.io/ietf-tools/datatracker-db:latest` Nightly database dumps of the datatracker are available as Docker images: `ghcr.io/ietf-tools/datatracker-db:latest`
> Note that to update the database in your dev environment to the latest version, you should run the `docker/cleandb` script. > [!TIP]
> In order to update the database in your dev environment to the latest version, you should run the `docker/cleandb` script.
### Blob storage for dev/test ### Blob storage for dev/test
@ -248,6 +251,7 @@ From a datatracker container, run the command:
./ietf/manage.py test --settings=settings_test ./ietf/manage.py test --settings=settings_test
``` ```
> [!TIP]
> You can limit the run to specific tests using the `--pattern` argument. > You can limit the run to specific tests using the `--pattern` argument.
### Frontend Tests ### Frontend Tests
@ -257,11 +261,13 @@ Frontend tests are done via Playwright. There're 2 different type of tests:
- Tests that test Vue pages / components and run natively without any external dependency. - Tests that test Vue pages / components and run natively without any external dependency.
- Tests that require a running datatracker instance to test against (usually legacy views). - Tests that require a running datatracker instance to test against (usually legacy views).
> [!IMPORTANT]
> Make sure you have Node.js 16.x or later installed on your machine. > Make sure you have Node.js 16.x or later installed on your machine.
#### Run Vue Tests #### Run Vue Tests
> :warning: All commands below **MUST** be run from the `./playwright` directory, unless noted otherwise. > [!WARNING]
> All commands below **MUST** be run from the `./playwright` directory, unless noted otherwise.
1. Run **once** to install dependencies on your system: 1. Run **once** to install dependencies on your system:
```sh ```sh
@ -294,7 +300,8 @@ Frontend tests are done via Playwright. There're 2 different type of tests:
First, you need to start a datatracker instance (dev or prod), ideally from a docker container, exposing the 8000 port. First, you need to start a datatracker instance (dev or prod), ideally from a docker container, exposing the 8000 port.
> :warning: All commands below **MUST** be run from the `./playwright` directory. > [!WARNING]
> All commands below **MUST** be run from the `./playwright` directory.
1. Run **once** to install dependencies on your system: 1. Run **once** to install dependencies on your system:
```sh ```sh