Skip to content

Commit f5039aa

Browse files
docs: add markdown for development (#138)
1 parent aead6f8 commit f5039aa

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

DEVELOPMENT.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Every new feature needs to come with following things:
2+
3+
An RFC on GitHub where it is decided if the feature is going to be implemented or not, including some basic implementation and design details.
4+
5+
SignalStore features start with an `with`, followed by the feature name. For example, `with-encryption`. You create it the source file in `libs/ngrx-toolkit/src/lib`.
6+
7+
If the feature does not fit into one file, divide it up into multiple files and put them into a folder with the same name as the feature. For example, as it is done with `withDevtools()`.
8+
9+
In case the feature uses third-party libraries, we need to provide a secondary entry point. An existing example is the `redux-connector` in `libs/ngrx-toolkit/redux-connector`.
10+
11+
Further necessary things for a new feature:
12+
13+
- Test
14+
- Unit Tests
15+
- E2E Tests
16+
- Documentation in
17+
- `/docs`
18+
- as well at the function itself via JSDoc

0 commit comments

Comments
 (0)