Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(app): improve developer guides for local development #2307

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.

Sign up for GitHub

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

Jump to bottom
Merged
markwhitfeld merged 2 commits into from
Feb 21, 2025
Merged

docs(app): improve developer guides for local development #2307

markwhitfeld merged 2 commits into from
Feb 21, 2025

Conversation

@nikosanif
Copy link
Contributor

@nikosanif nikosanif commented Feb 19, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

This PR improves the NGXS Developer Guide by refining structure, improving readability, and ensuring accuracy in testing commands. The changes include:

  • Refined structure and readability of the local development guide.
  • Improved formatting for installation and contribution steps.
  • Make the Developer Guide accessible on the documentation site
  • Corrected the yarn test:ci command to yarn test.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

N/A

@nx-cloud
Copy link

nx-cloud bot commented Feb 19, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit c9bde6f.

Command Status Duration Result
nx run-many --target=lint --all --exclude=creat... ✅ Succeeded 1s View ↗
nx run-many --target=test --all --configuration... ✅ Succeeded 2s View ↗
nx lint-types store ✅ Succeeded <1s View ↗
nx run-many --target=build --all ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-21 15:46:53 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 19, 2025 •
edited
Loading

Open in Stackblitz

@ngxs/devtools-plugin

npm i https://pkg.pr.new/@ngxs/devtools-plugin@2307

@ngxs/form-plugin

npm i https://pkg.pr.new/@ngxs/form-plugin@2307

@ngxs/hmr-plugin

npm i https://pkg.pr.new/@ngxs/hmr-plugin@2307

@ngxs/router-plugin

npm i https://pkg.pr.new/@ngxs/router-plugin@2307

@ngxs/storage-plugin

npm i https://pkg.pr.new/@ngxs/storage-plugin@2307

@ngxs/store

npm i https://pkg.pr.new/@ngxs/store@2307

@ngxs/websocket-plugin

npm i https://pkg.pr.new/@ngxs/websocket-plugin@2307

commit: c9bde6f

@bundlemon
Copy link

bundlemon bot commented Feb 19, 2025

BundleMon

Unchanged files (6)
Status Path Size Limits
❌ fesm2022/ngxs-store.mjs
 105.43KB 105KB / +0.5%
✅ fesm2022/ngxs-store-internals.mjs
 11.82KB 13KB / +0.5%
✅ fesm2022/ngxs-store-internals-testing.mjs
 6.8KB 7KB / +0.5%
✅ fesm2022/ngxs-store-operators.mjs
 6.22KB 7KB / +0.5%
✅ fesm2022/ngxs-store-plugins.mjs
 2.38KB 3KB / +0.5%
✅ fesm2022/ngxs-store-experimental.mjs
 574B 2KB / +0.5%

No change in files bundle size

Unchanged groups (1)
Status Path Size Limits
✅ @ngxs/store(fesm2022)[gzip]
./fesm2022/*.mjs
 32.07KB +1%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

@bundlemon
Copy link

bundlemon bot commented Feb 19, 2025

BundleMon (NGXS Plugins)

Unchanged files (9)
Status Path Size Limits
✅ Plugins(fesm2022)[gzip]
storage-plugin/fesm2022/ngxs-storage-plugin.m
js
 3.98KB +0.5%
✅ Plugins(fesm2022)[gzip]
router-plugin/fesm2022/ngxs-router-plugin.mjs
 2.96KB +0.5%
✅ Plugins(fesm2022)[gzip]
hmr-plugin/fesm2022/ngxs-hmr-plugin.mjs
 2.63KB +0.5%
✅ Plugins(fesm2022)[gzip]
websocket-plugin/fesm2022/ngxs-websocket-plug
in.mjs
 2.56KB +0.5%
✅ Plugins(fesm2022)[gzip]
form-plugin/fesm2022/ngxs-form-plugin.mjs
 2.46KB +0.5%
✅ Plugins(fesm2022)[gzip]
devtools-plugin/fesm2022/ngxs-devtools-plugin
.mjs
 2.15KB +0.5%
✅ Plugins(fesm2022)[gzip]
logger-plugin/fesm2022/ngxs-logger-plugin.mjs
 2.01KB +0.5%
✅ Plugins(fesm2022)[gzip]
storage-plugin/fesm2022/ngxs-storage-plugin-i
nternals.mjs
 861B +0.5%
✅ Plugins(fesm2022)[gzip]
router-plugin/fesm2022/ngxs-router-plugin-int
ernals.mjs
 396B +0.5%

No change in files bundle size

Unchanged groups (1)
Status Path Size Limits
✅ All Plugins(fesm2022)[gzip]
./-plugin/fesm2022/.mjs
 19.96KB +0.5%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

@bundlemon
Copy link

bundlemon bot commented Feb 19, 2025

BundleMon (Integration Projects)

Files added (1)
Status Path Size Limits
✅ Main bundles(Gzip)
hello-world-ng19/dist-integration/browser/mai
n-(hash).js
 +66.28KB +1%
Files removed (3)
Status Path Size Limits
✅ Main bundles(Gzip)
hello-world-ng18/dist-integration/browser/mai
n-(hash).js
 -70.1KB +1%
✅ Main bundles(Gzip)
hello-world-ng17/dist-integration/main.(hash)
.js
 -68.24KB +1%
✅ Main bundles(Gzip)
hello-world-ng16/dist-integration/main.(hash)
.js
 -67.3KB +1%

Total files change -139.36KB -67.77%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

@qlty-cloud-legacy
Copy link

qlty-cloud-legacy bot commented Feb 21, 2025

Code Climate has analyzed commit c9bde6f and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 95.3% (0.0% change).

View more on Code Climate.

markwhitfeld
markwhitfeld approved these changes Feb 21, 2025
View reviewed changes
Copy link
Member

@markwhitfeld markwhitfeld left a comment

Choose a reason for hiding this comment

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

Great contribution! Thank you.

@markwhitfeld markwhitfeld merged commit fb07d3f into ngxs:master Feb 21, 2025
14 checks passed
@nikosanif nikosanif deleted the docs-developer-guides branch February 24, 2025 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markwhitfeld markwhitfeld markwhitfeld approved these changes

@profanis profanis profanis approved these changes

@arturovt arturovt Awaiting requested review from arturovt arturovt is a code owner

@kuncevic kuncevic Awaiting requested review from kuncevic kuncevic is a code owner

@Carniatto Carniatto Awaiting requested review from Carniatto Carniatto is a code owner

@poloagustin poloagustin Awaiting requested review from poloagustin poloagustin is a code owner

@joaqcid joaqcid Awaiting requested review from joaqcid joaqcid is a code owner

@splincode splincode Awaiting requested review from splincode splincode is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nikosanif @markwhitfeld @profanis