We love contributors! Your help is welcome to make this project better!
Some simple guidelines we'd like you to follow.
If you have questions about http-proxy-middleware usage, please check whether your question has already been answered on Stack Overflow or in our FAQ, issue archive, examples and recipes.
As httpxy provides the actual proxy functionality, you might find your answer in their documentation, issue archive or have a look in the older http-proxy examples.
Create a new issue if you think you've found an issue.
"It doesn't work" is not very useful for anyone. A good issue report should have a well-described problem description, along with the proxy configuration. A great issue report includes a minimal example.
Properly format your code example for easier reading: Code and Syntax Highlighting.
The quality of your issue report will determine how quickly and deeply we'll delve into it.
Request a new feature in the issue tracker.
PRs are welcome. Please discuss it in our GitHub issue tracker before you start working on it, to avoid wasting your time and effort in case we are already working on it or planning to.
Feel free to send PRs to improve the documentation, examples and recipes.
Run the following commands before opening a PR:
# install dependencies
$ yarn
# linting
$ yarn lint
$ yarn lint:fix
# building (compile typescript to js)
$ yarn build
# unit tests
$ yarn test
# code coverage
$ yarn coverage
# check spelling mistakes
$ yarn spellcheck