Skip to content

[DX] Mention Doctor Rst in CONTRIBUTING.md #2472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,21 @@ Thanks to [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you can al
- `yarn run check`: run the formatter, linter, and sort imports for **all** packages, and fails if any modifications
- `yarn run check --write`: run the formatter, linter, imports sorting for **all** packages, and write modifications

### Working on documentation

Symfony UX documentation is written in ReStructuredText (`.rst`) and is located in the `docs/` directory
of each package.

When contributing to the documentation, please make sure to follow the Symfony
[documentation guidelines](https://symfony.com/doc/current/contributing/documentation/index.html).

To verify your changes locally, you can use the `oskarstark/doctor-rst` Docker image. Run the following
command from the root directory of the projet:

```shell
docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}:/docs oskarstark/doctor-rst -vvv
```

## Useful Git commands

1. To keep your fork up-to-date with the upstream repository and `2.x` branch, you can run the following commands:
Expand Down
Loading