Skip to content

Commit

Permalink
Edited README
Browse files Browse the repository at this point in the history
  • Loading branch information
@axel-op
axel-op committed Oct 8, 2019
1 parent 2c09fb0 commit be4d3bd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
relativePath: 'packages/mypackage/'
```
* `githubToken`, `eventPayload`, and `commitSha` inputs are required to post a comment on GitHub.
* `githubToken` input is required to post a comment on GitHub.
* Use `maxScoreToComment` if you only want to have a comment if your score is lower than this. If you don't specify it, a comment will be posted for every commit that triggers the workflow. In this example, a comment won't be posted if the score is above 99.99, that is, if it equals 100.
* If your package isn't at the root of the repository, use `relativePath` to indicate its location.

1 comment on commit be4d3bd

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Package analysis results for commit be4d3bd

(version of pana used: 0.12.21)

  • Health score is 96.55 / 100.0
  • Maintenance score is 50.0 / 100.0

Please note that 50% of the overall score of your package on the Pub site will be based on its popularity ; 30% on its health score ; and 20% on its maintenance score.

Issues

Health

  • Fix lib/test_package.dart (3.45 points): Analysis of lib/test_package.dart reported 7 hints, including:
    • line 6 col 22: 'valueTest' is deprecated and shouldn't be used.
    • line 13 col 22: 'value4' is deprecated and shouldn't be used.
    • line 26 col 32: 'value' is deprecated and shouldn't be used.
    • line 31 col 9: The value of the local variable 'sum' isn't used.
    • line 31 col 18: 'value' is deprecated and shouldn't be used.

Maintenance

  • Homepage URL isn't helpful (10.0 points): Update the homepage field from pubspec.yaml: link to a website about the package or use the source repository URL.
  • The package description is too short (20.0 points): Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.
  • Maintain an example (10.0 points): Create a short demo in the example/ directory to show how to use this package.
    • Common filename patterns include main.dart, example.dart, and test_package.dart. Packages with multiple examples should provide example/README.md.
    • For more information see the pub package layout conventions.
  • Package is pre-v0.1 release (10.0 points): While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Please sign in to comment.