Skip to content

Incorrect/ missing contribution information in README #18710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Jefiozie opened this issue Sep 7, 2020 · 4 comments · Fixed by #18714
Closed

Incorrect/ missing contribution information in README #18710

Jefiozie opened this issue Sep 7, 2020 · 4 comments · Fixed by #18714
Labels
area: docs Related to the documentation area: etc/misc freq1: low Only reported by a handful of users who observe it rarely good first issue severity3: broken type: bug/fix
Milestone

Comments

@Jefiozie
Copy link
Contributor

Jefiozie commented Sep 7, 2020

Hi there,

I was looking to contribute to #17579 I've started reading the README file to see what the correct steps where for contribution and other information. While reading it looks to me that the is missing or incorrect information in the testing chapter of the README file. It looks like there have been changes around the test and these steps are not valid anymore.

In older versions, the test script run node ./bin/devkit-admin test, is this still the approach we should take?

Thanks.

PS I hope this is the correct issue template for these kinds of issues.

@alan-agius4 alan-agius4 added area: etc/misc area: docs Related to the documentation labels Sep 7, 2020
@ngbot ngbot bot added this to the Backlog milestone Sep 7, 2020
@alan-agius4 alan-agius4 added severity3: broken type: bug/fix freq1: low Only reported by a handful of users who observe it rarely labels Sep 7, 2020
@alan-agius4
Copy link
Collaborator

Hi there,

You are correct the readme is outdated.

To test a single package

yarn bazel test //packages/schematics/update:update_test
yarn bazel test //packages/schematics/angular:no_typescript_runtime_dep_test
yarn bazel test //packages/schematics/angular:angular_test
yarn bazel test //packages/ngtools/webpack:webpack_test
yarn bazel test //packages/angular_devkit/schematics_cli:schematics_cli_test
yarn bazel test //packages/angular_devkit/schematics/tools:tools_test
yarn bazel test //packages/angular_devkit/schematics/tasks:tasks_test
yarn bazel test //packages/angular_devkit/schematics:schematics_test
yarn bazel test //packages/angular_devkit/core/node:node_test
yarn bazel test //packages/angular_devkit/core:core_test
yarn bazel test //packages/angular_devkit/build_webpack:build_webpack_test
yarn bazel test //packages/angular_devkit/build_optimizer:build_optimizer_test
yarn bazel test //packages/angular_devkit/build_ng_packagr:build_ng_packagr_ve_test
yarn bazel test //packages/angular_devkit/build_ng_packagr:build_ng_packagr_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_tslint_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_server_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_protractor_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_ng-packagr_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_karma_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_extract-i18n_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_dev-server_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_browser_ve_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_browser_test
yarn bazel test //packages/angular_devkit/build_angular:build_angular_app-shell_test
yarn bazel test //packages/angular_devkit/benchmark:benchmark_test
yarn bazel test //packages/angular_devkit/architect:architect_test
yarn bazel test //packages/angular/pwa:pwa_test
yarn bazel test //packages/angular/cli:angular-cli_test

Test all packages
yarn bazel test packages/...

@Jefiozie
Copy link
Contributor Author

Jefiozie commented Sep 7, 2020

Thanks for the quick response should I update the README?

@alan-agius4
Copy link
Collaborator

A PR would be awesome 😁.

\I'd suggest thought that we don't add all the test targets in the read me since these change overtime.

I'd suggest to add an example, something along:

To test a single package use the full Bazel target example:

yarn bazel test //packages/schematics/angular:angular_test

For a a complete list of test targets use the below Bazel query:

yarn bazel query "tests(//packages/...)"

Also it would be great to add a note along:

You can find more info about debugging tests with Bazel in the docs.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Oct 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: docs Related to the documentation area: etc/misc freq1: low Only reported by a handful of users who observe it rarely good first issue severity3: broken type: bug/fix
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants