Skip to content

docs: update README_contributors.md for current Nx workflow#754

Merged
dianjuar merged 3 commits into
mainfrom
docs/update-readme-contributors
May 31, 2026
Merged

docs: update README_contributors.md for current Nx workflow#754
dianjuar merged 3 commits into
mainfrom
docs/update-readme-contributors

Conversation

@dianjuar
Copy link
Copy Markdown
Member

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)

What is the current behavior?

docs/README_contributors.md is outdated: it references yarn install, Angular-only workspace setup, legacy Nx CLI paths, and .npmrc for Node version. It also lacks guidance for create-nx-workspace, common Nx tasks, and how to run e2e/smoke tests locally.

Issue Number: #559

What is the new behavior?

Contributor docs now reflect the current repo workflow:

  • Setup with Node from .nvmrc and npm ci
  • Common tasks table (build, test, lint, e2e, smoke)
  • External workspace testing via create-nx-workspace, npm link/yalc, install generator, and dry-run deploy
  • E2E/smoke run commands plus Verdaccio/create-nx-workspace flow and useful env vars
  • Updated debug, commit, and Sonar instructions

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Documentation-only change; no runtime or test updates required.

Refresh contributor setup, testing, and e2e docs. Closes #559.

Co-authored-by: Cursor <cursoragent@cursor.com>
@bikecoders bikecoders deleted a comment from sonarqubecloud Bot May 31, 2026
@bikecoders bikecoders deleted a comment from github-actions Bot May 31, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 31, 2026

Release preview

Simulates squash merge into main using the PR title as the commit message.
Only changes under packages/ngx-deploy-npm affect the version.

PR title: docs: update README_contributors.md for current Nx workflow

Semantic commit (PR title)

✅ Valid conventional commit

Version

9.1.09.2.0

Changelog preview

## [9.2.0](https://github.com/bikecoders/ngx-deploy-npm/compare/ngx-deploy-npm-9.1.0...ngx-deploy-npm-9.2.0) (2026-05-31)


### Features

* **ngx-deploy-npm:** extend checkExisting with skip mode and checkTag ([#749](https://github.com/bikecoders/ngx-deploy-npm/issues/749)) ([1250a91](https://github.com/bikecoders/ngx-deploy-npm/commit/1250a9189f46e62e56b03cde76522663c9918467))
* **ngx-deploy-npm:** forward npm publish passthrough flags ([#751](https://github.com/bikecoders/ngx-deploy-npm/issues/751)) ([371751b](https://github.com/bikecoders/ngx-deploy-npm/commit/371751b0f41fac6acb6597d6860ae4a88f86aecc))
* **ngx-deploy-npm:** log post-publish summary with streaming tarball size ([#750](https://github.com/bikecoders/ngx-deploy-npm/issues/750)) ([dbfe288](https://github.com/bikecoders/ngx-deploy-npm/commit/dbfe288a69f52f3749a6d80d4c54ddc87ea8afb0)), closes [#749](https://github.com/bikecoders/ngx-deploy-npm/issues/749)


### Bug Fixes

* **ngx-deploy-npm:** apply packageVersion transiently during dry-run ([#752](https://github.com/bikecoders/ngx-deploy-npm/issues/752)) ([cf7013f](https://github.com/bikecoders/ngx-deploy-npm/commit/cf7013f6311c1cbe3ab81dfe08b366ac323265df))
* **ngx-deploy-npm:** resolve open SonarCloud static analysis issues ([#746](https://github.com/bikecoders/ngx-deploy-npm/issues/746)) ([599ac29](https://github.com/bikecoders/ngx-deploy-npm/commit/599ac2971841cdec6fd720428ed2ae5546492ed5))

Generated by CI (PR Release Preview). Actual release runs on merge via publishment.yml.

Notes: Preview uses only the PR title (squash merge). Changes outside packages/ngx-deploy-npm do not trigger a version bump. Breaking changes must appear in the title (e.g. feat!:), not only in the PR description.

@sonarqubecloud
Copy link
Copy Markdown

@dianjuar dianjuar merged commit 10d341f into main May 31, 2026
31 checks passed
@dianjuar dianjuar deleted the docs/update-readme-contributors branch May 31, 2026 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant