Skip to content

Commit

Permalink
Address CR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
piotruela committed Nov 25, 2024
1 parent 2845773 commit 49ddb0d
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,25 @@

If you're thinking about contributing to Patrol, thank you! We appreciate your help. Before you get started, we encourage you to read this document. It should make your contributing experience a bit better.

## Opening a PR

Before opening a PR with your changes, make sure you have updated the changelog for the package you modified.

In the PR description mention the issue that this PR resolves. If that issue doesn't exist, create one or describe in detail the changes introduced by this PR.

Use `## Unreleased` title if you're not sure what should be next version number.

Be aware that `test android emulator` and `test android emulator webview` workflows will fails due to insufficient permission of a contributor. Those will have to be re-run by someone with the write access in the repository.

## Running patrol_cli locally

If you want to work with a local version of patrol_cli, you can pick one of two approaches:

Activate patrol_cli locally by typing `dart pub global activate --source path {path to packages/patrol_cli}`. After that you can use `patrol` command exactly the same as any other pub package.
Activate patrol_cli locally by typing `dart pub global activate --source path [path to packages/patrol_cli]`. After that you can use `patrol` command exactly the same as any other pub package.

OR

Use `dart run {path to packages/patrol_cli} {command you want to test}`.
Use `dart run [path to packages/patrol_cli] <command you want to test>`.

## Debugging patrol_cli

Expand Down Expand Up @@ -69,11 +79,3 @@ Native methods API is generated from a schema. If you wish to modify any of thes
## Working with patrol_devtools_extension

If you plan to use the local version of Patrol to test/modify the Patrol DevTools extension, you need to deploy it first. To do this, navigate to the `patrol_devtools_extension` folder and run the `./publish_to_patrol_extension` script.

## Opening a PR

Before opening a PR with your changes, make sure you have updated the changelog for the package you modified.

Use `## Unreleased` title if you're not sure what should be next version number.

Be aware that `test android emulator` and `test android emulator webview` workflows will fails due to insufficient permission of a contributor. Those will have to be re-run by someone with the write access in the repository.

0 comments on commit 49ddb0d

Please sign in to comment.