Skip to content

Commit

Permalink
lint
Browse files Browse the repository at this point in the history
  • Loading branch information
b1ron committed Aug 20, 2023
1 parent f2cdc00 commit f46680c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ For example if you wanted to add your Node.js application to dance, you would do
1. Add the submodule to the `tests` directory `git submodule add https://github.com/my-org/my-app.git`.
2. Create a shell script in the `tests` directory called `my-app-runtime.sh` with the required logic needed to run your test.
3. Create a YAML file called `my-app.yml` in the `tests` directory and provide the `args` field with the shell script so that the runner can invoke it.
4. Start the environment and test it locally before submitting a PR to ensure that it works correctly. Refer to the above [section](https://github.com/FerretDB/dance/blob/main/CONTRIBUTING.md#starting-environment-with-docker-compose) on how to start the environment.
4. Start the environment and test it locally before submitting a PR to ensure that it works correctly.
Refer to the above [section](https://github.com/FerretDB/dance/blob/main/CONTRIBUTING.md#starting-environment-with-docker-compose) on how to start the environment.
5. Run the test locally to verify the output `bin/task dance DB=ferretdb TEST=my-app`.
6. Submit a PR to [dance](https://github.com/FerretDB/dance) with a title of the form "Run MyApp tests on CI".

Expand Down

0 comments on commit f46680c

Please sign in to comment.