You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Create a branch with a descriptive name in the relevant repositories
14
-
* Make your changes, run tests, commit with a [descriptive message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), push to your fork
15
-
* Submit pull requests with an explanation what has been changed and **why**
16
-
* Submit a filled out and signed [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) if needed (see below)
17
-
* Be patient. We will get to your pull request eventually
21
+
The team receives many questions through various venues every single
22
+
day. Frequently, these questions do not include the necessary details
23
+
the team needs to begin useful work. GitHub issues can very quickly
24
+
turn into a something impossible to navigate and make sense
25
+
of. Because of this, questions, investigations, root cause analysis,
26
+
and discussions of potential features are all considered to be
27
+
[mailing list][rmq-users] material. If you are unsure where to begin,
28
+
the [RabbitMQ users mailing list][rmq-users] is the right place.
18
29
19
-
If what you are going to work on is a substantial change, please first ask the core team
20
-
of their opinion on [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).
30
+
Getting all the details necessary to reproduce an issue, make a
31
+
conclusion or even form a hypothesis about what's happening can take a
32
+
fair amount of time. Please help others help you by providing a way to
33
+
reproduce the behavior you're observing, or at least sharing as much
34
+
relevant information as possible on the [RabbitMQ users mailing
35
+
list][rmq-users].
21
36
37
+
Please provide versions of the software used:
22
38
23
-
## Code of Conduct
39
+
* RabbitMQ server
40
+
* Erlang
41
+
* Operating system version (and distribution, if applicable)
42
+
* All client libraries used
43
+
* RabbitMQ plugins (if applicable)
24
44
25
-
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
45
+
The following information greatly helps in investigating and reproducing issues:
46
+
47
+
* RabbitMQ server logs
48
+
* A code example or terminal transcript that can be used to reproduce
49
+
* Full exception stack traces (a single line message is not enough!)
50
+
*`rabbitmqctl report` and `rabbitmqctl environment` output
51
+
* Other relevant details about the environment and workload, e.g. a traffic capture
52
+
* Feel free to edit out hostnames and other potentially sensitive information.
53
+
54
+
To make collecting much of this and other environment information, use
55
+
the [`rabbitmq-collect-env`][rmq-collect-env] script. It will produce an archive with
56
+
server logs, operating system logs, output of certain diagnostics commands and so on.
57
+
Please note that **no effort is made to scrub any information that may be sensitive**.
58
+
59
+
### Pull Requests
26
60
61
+
RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions.
62
+
Pull requests is the primary place of discussing code changes.
63
+
64
+
Here's the recommended workflow:
65
+
66
+
*[Fork the repository][github-fork] or repositories you plan on contributing to. If multiple
67
+
repositories are involved in addressing the same issue, please use the same branch name
68
+
in each repository
69
+
* Create a branch with a descriptive name in the relevant repositories
70
+
* Make your changes, run tests (usually with `make tests`), commit with a
71
+
[descriptive message][git-commit-msgs], push to your fork
72
+
* Submit pull requests with an explanation what has been changed and **why**
73
+
* Submit a filled out and signed [Contributor Agreement][ca-agreement] if needed (see below)
74
+
* Be patient. We will get to your pull request eventually
75
+
76
+
If what you are going to work on is a substantial change, please first
77
+
ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-users].
27
78
28
79
## Running Tests
29
80
@@ -49,15 +100,24 @@ Finally,
49
100
50
101
will run all suites.
51
102
103
+
## Code of Conduct
52
104
53
-
## Contributor Agreement
105
+
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
54
106
55
-
If you want to contribute a non-trivial change, please submit a signed copy of our
56
-
[Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) around the time
57
-
you submit your pull request. This will make it much easier (in some cases, possible)
58
-
for the RabbitMQ team at Pivotal to merge your contribution.
107
+
## Contributor Agreement
59
108
109
+
If you want to contribute a non-trivial change, please submit a signed
110
+
copy of our [Contributor Agreement][ca-agreement] around the time you
111
+
submit your pull request. This will make it much easier (in some
112
+
cases, possible) for the RabbitMQ team at Pivotal to merge your
113
+
contribution.
60
114
61
115
## Where to Ask Questions
62
116
63
-
If something isn't clear, feel free to ask on our [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).
117
+
If something isn't clear, feel free to ask on our [mailing list][rmq-users].
0 commit comments