Skip to content

Commit 4946b25

Browse files
committed
Add goals to readme
1 parent 2eef9e6 commit 4946b25

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,17 @@ This project is heavily inspired by [peerigon/nof5](https://github.com/peerigon/
1616

1717
The client scripts are built with `npm run-script prepublish`.
1818

19+
When making a PR, keep these goals in mind:
20+
21+
- The communication library (Sock.js) should not be exposed to the user.
22+
- A user should not try to implement stuff that accesses the webpack filesystem, because this lead to bugs (the middleware does it while blocking requests until the compilation has finished, the blocking is important).
23+
- It should be a development only tool (compiling in production is bad, one should precompile and deliver the compiled assets).
24+
- There are hooks to add your own features, so we should not add less-common features.
25+
- Processing options and stats display is delegated to webpack, so webpack-dev-server/middleware should not do much with it. This also helps us to keep up-to-date with webpack updates.
26+
- The workflow should be to start webpack-dev-server as a separate process, next to the "normal" server and to request the script from this server or to proxy from dev-server to "normal" server (because webpack blocks the event queue too much while compiling which can affect "normal" server).
27+
1928
## License
2029

21-
Copyright 2012-2014 Tobias Koppers
30+
Copyright 2012-2016 Tobias Koppers
2231

2332
[MIT](http://www.opensource.org/licenses/mit-license.php)

0 commit comments

Comments
 (0)