| 1 | # Contributing
|
| 2 |
|
| 3 | We love contributors! Your help is welcome to make this project better!
|
| 4 |
|
| 5 | Some simple guidelines we'd like you to follow.
|
| 6 |
|
| 7 | ## Got Questions or Problems?
|
| 8 |
|
| 9 | If you have questions about http-proxy-middle usage; Please check if your question hasn't been already answered on [Stack Overflow](http://stackoverflow.com/search?q=%22http-proxy-middleware%22) or in our [issue archive](https://github.com/chimurai/http-proxy-middleware/issues?utf8=%E2%9C%93&q=is%3Aissue+), [examples](https://github.com/chimurai/http-proxy-middleware/tree/master/examples) and [recipes](https://github.com/chimurai/http-proxy-middleware/tree/master/recipes).
|
| 10 |
|
| 11 | Since Nodejitsu's `http-proxy` is providing the actual proxy functionality; You might find your answer in their [documentation](https://github.com/nodejitsu/node-http-proxy), [issue archive](https://github.com/nodejitsu/node-http-proxy/issues?utf8=%E2%9C%93&q=is%3Aissue) or [examples](https://github.com/nodejitsu/node-http-proxy/tree/master/examples).
|
| 12 |
|
| 13 | Feel free to [ask a question](https://github.com/chimurai/http-proxy-middleware/issues) if the above resources didn't answer your question.
|
| 14 |
|
| 15 | Tips on how to ask: http://stackoverflow.com/help/how-to-ask
|
| 16 |
|
| 17 | ## Report Issues
|
| 18 |
|
| 19 | If you think you've found an issue, please submit it to the [Github issue tracker](https://github.com/chimurai/http-proxy-middleware/issues).
|
| 20 |
|
| 21 | "*[It doesn't work](https://goo.gl/GzkkTg)*" is not very useful for anyone.
|
| 22 | A good issue report should have a well described **problem description** and proxy **configuration**. A great issue report includes a **minimal example**.
|
| 23 |
|
| 24 | Properly format your code example for easier reading: [Code and Syntax Highlighting](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code-and-syntax-highlighting).
|
| 25 |
|
| 26 | The quality of your issue report will determine how quickly and deeply we'll delve into it. Some simple pointers for reporting an issue:
|
| 27 |
|
| 28 | #### Problem Description
|
| 29 |
|
| 30 | - describe the problem
|
| 31 | - steps taken (request urls)
|
| 32 | - found
|
| 33 | - expected
|
| 34 |
|
| 35 | #### Configuration / Setup
|
| 36 |
|
| 37 | - http-proxy-middleware version
|
| 38 | - http-proxy-middleware configuration
|
| 39 |
|
| 40 | It might be useful to provide server information in which http-proxy-middleware is used and the target server information to which requests are being proxied.
|
| 41 |
|
| 42 | - server + version (express, connect, browser-sync, etc...)
|
| 43 | + server port number
|
| 44 | - target server
|
| 45 | + target server port number
|
| 46 |
|
| 47 | ### Minimal example
|
| 48 |
|
| 49 | Provide a minimal example to exclude external factors. This will greatly help identifying the issue.
|
| 50 |
|
| 51 | Tips on how to create a minimal example: http://stackoverflow.com/help/mcve
|
| 52 |
|
| 53 | ## New Feature?
|
| 54 |
|
| 55 | Request a new feature by submitting an issue into our [Github issue tracker](https://github.com/chimurai/http-proxy-middleware/issues).
|
| 56 |
|
| 57 | PRs are welcome. Please discuss it in our [Github issue tracker](https://github.com/chimurai/http-proxy-middleware/issues) before you start working on it, to avoid wasting your time and effort in case we are already (planning to) working on it.
|
| 58 |
|
| 59 | ## Documentation
|
| 60 |
|
| 61 | Feel free to send PRs to improve the documentation, [examples](https://github.com/chimurai/http-proxy-middleware/tree/master/examples) and [recipes](https://github.com/chimurai/http-proxy-middleware/tree/master/recipes).
|