From e7ba368fce3532828ecf33e819cd56f1294b17bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Valim?= Date: Mon, 8 Apr 2024 10:16:41 +0200 Subject: [PATCH] Simplify contribution steps --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fd9b3bc24..0799d70b8 100644 --- a/README.md +++ b/README.md @@ -452,11 +452,11 @@ For more details and configuration options, see the [Mermaid usage docs](https:/ The easiest way to test changes to ExDoc is to locally rebuild the app and its own documentation: - 1. Run `mix setup` to install all dependencies. - 2. Run `mix build` to generate the docs. This is a custom alias that will build assets, recompile ExDoc, and output fresh docs into the `doc/` directory. - 3. If working on the assets, you may wish to run the assets build script in watch mode: `npm run --prefix assets build:watch`. - 4. Run `mix lint` to check if the Elixir and JavaScript files are properly formatted. You can run `mix fix` to let the JavaScript linter and Elixir formatter fix the code automatically before submitting your pull request. - 5. Please do not add the files generated in the `formatters/` directory to your commits. These will be handled as necessary by the repository maintainers. + 1. Run `mix setup` to install all dependencies + 2. Run `mix build` to generate the docs and open up the generated `doc/index.html` + 3. (optional) Run `npm run --prefix assets build:watch` if working on assets for automatic recompilation + 4. Run `mix lint` to check linting and formatting (and `mix fix` to automatically fix it) + 5. (important) Do not add the files in the `formatters/` directory to your commits, those will be handled by the maintainers See the README in the `assets/` directory for more information on working on the assets.