Skip to content
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

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

Closed
2 tasks
timdeschryver opened this issue Aug 21, 2024 · 6 comments · Fixed by #4521
Closed
2 tasks
Labels
Accepting PRs community watch Someone from the community is working this issue/PR Comp: Docs Good First Issue Good issue for first-time contributor Project: ESLint Plugin

Comments

@timdeschryver
Copy link
Member

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

  • Yes
  • No
@ghost
Copy link

ghost commented Aug 24, 2024

@timdeschryver
Copy link
Member Author

That would be awesome @paweltwardziak !

@ghost
Copy link

ghost commented Aug 24, 2024

Ok @timdeschryver, on it

@timdeschryver timdeschryver added the community watch Someone from the community is working this issue/PR label Aug 24, 2024
@ghost
Copy link

ghost commented Sep 2, 2024

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

@ghost
Copy link

ghost commented Sep 3, 2024

@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
Copy link
Member Author

@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. 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepting PRs community watch Someone from the community is working this issue/PR Comp: Docs Good First Issue Good issue for first-time contributor Project: ESLint Plugin
Projects
None yet
1 participant