Add more information to CONTRIBUTING.MD #2413
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
To view this pull requests documentation preview, visit the following URL: docs.page/leancodepl/patrol~2413 Documentation is deployed and generated using docs.page. |
pdenert
reviewed
Nov 14, 2024
Comment on lines
+73
to
+79
| ## 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. |
There was a problem hiding this comment.
I would put this at the beginning of the file, as it applies to every PR.
You can also add information in the description that mentions issues that have been fixed by this PR. If that problem doesn't exist, it's good practice to create one, or at least describe exactly what the problem was.
pdenert
reviewed
Nov 14, 2024
|
|
||
| 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. |
There was a problem hiding this comment.
I think that instead of {} you should use []. It has been used like that eg. in patrol --help
Usage: patrol <command> [arguments]
pdenert
reviewed
Nov 14, 2024
|
|
||
| OR | ||
|
|
||
| Use `dart run {path to packages/patrol_cli} {command you want to test}`. |
There was a problem hiding this comment.
Same here, I think this should be:
Suggested change
| 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>`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2409 and #1964