search

ngrx / platform

Reactive State for Angular
https://ngrx.io
Other
8.04k stars 1.98k forks source link

Add documentation for the ESLint rule signal-store-feature-should-use-generic-type #4502

Closed timdeschryver closed 1 month ago

timdeschryver commented 2 months ago

Information

The rule signal-store-feature-should-use-generic-type should be documented at https://github.com/ngrx/platform/blob/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-store-feature-should-use-generic-type.md.

It should also contain one or more examples showcasing some "bad" and "good" snippets. For some examples we can take a look at the test cases at https://github.com/ngrx/platform/blob/main/modules/eslint-plugin/spec/rules/signals/signal-store-feature-should-use-generic-type.spec.ts

Documentation page

https://ngrx.io/guide/eslint-plugin/rules/signal-store-feature-should-use-generic-type

I would be willing to submit a PR to fix this issue

ghost commented 2 months ago

@timdeschryver if you ok with that, I can make it same way I made it there https://github.com/ngrx/platform/blob/main/projects/ngrx.io/content/guide/eslint-plugin/rules/prefer-protected-state.md

timdeschryver commented 2 months ago

That would be awesome @paweltwardziak !

ghost commented 2 months ago

Ok @timdeschryver, on it

ghost commented 2 months ago

@timdeschryver Sorry for the delay, I've been a bit busy these past few days. Tomorrow I will raise my PR 👍

ghost commented 2 months ago

@timdeschryver see #4515 I've updated prefer-protected-state.md in that PR as well - I am not sure whether or not this is something acceptable to mix a little PR responibilities. Let me knwo - I can split it into two commits :)

timdeschryver commented 2 months ago

@timdeschryver see #4515 I've updated prefer-protected-state.md in that PR as well - I am not sure whether or not this is something acceptable to mix a little PR responibilities. Let me knwo - I can split it into two commits :)

For this case it's fine. 😉