e8bdaff80f
Motivation: CONTRIBUTING.md is useful only because it lets Github show a user the link to it so the user can check what information we need before submitting a bug report. However, Github does not do the same for a pull request submission form, and thus there's no reason to keep the information about how to submit a good pull request in CONTRIBUTING.md. Modification: Replace the section about issuing a pull request with the link to the official developer guide. Result: CONTRIBUTING.md is easier to maintain.
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
## How to submit a bug report
|
|
|
|
Please ensure to specify the following:
|
|
|
|
* Netty version (e.g. 4.0.17.Final)
|
|
* Contextual information (e.g. what you were trying to achieve with Netty)
|
|
* Simplest possible steps to reproduce
|
|
* More complex the steps are, lower the priority will be.
|
|
* A pull request with failing JUnit test case is most preferred, although it's OK to paste the test case into the issue description.
|
|
* Anything that might be relevant in your opinion, such as:
|
|
* JDK/JRE version or the output of `java -version`
|
|
* Operating system and the output of `uname -a`
|
|
* Network configuration
|
|
|
|
|
|
### Example
|
|
|
|
```
|
|
Netty version: 4.0.17.Final
|
|
|
|
Context:
|
|
I encountered an exception which looks suspicious while load-testing my Netty-based Thrift server implementation.
|
|
|
|
Steps to reproduce:
|
|
1. ...
|
|
2. ...
|
|
3. ...
|
|
4. ...
|
|
|
|
$ java -version
|
|
java version "1.7.0_51"
|
|
Java(TM) SE Runtime Environment (build 1.7.0_51-b13)
|
|
Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode)
|
|
|
|
Operating system: Ubuntu Linux 13.04 64-bit
|
|
|
|
$ uname -a
|
|
Linux infinity 3.10.32-1-lts #1 SMP Sun Feb 23 09:44:24 CET 2014 x86_64 GNU/Linux
|
|
|
|
My system has IPv6 disabled.
|
|
```
|
|
|
|
## How to contribute your work
|
|
|
|
Before submitting a pull request or push a commit, please read [our developer guide](http://netty.io/wiki/developer-guide.html).
|
|
|