Skip to content

Commit 3f77648

Browse files
committed
Add contribution page
1 parent df6552b commit 3f77648

File tree

3 files changed

+45
-3
lines changed

3 files changed

+45
-3
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Overview
2+
3+
RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions.
4+
Pull requests is the primary place of discussing code changes.
5+
6+
## How to Contribute
7+
8+
The process is fairly standard:
9+
10+
* Fork the repository
11+
* Create a branch with a descriptive name
12+
* 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
13+
* Submit pull requests with an explanation what has been changed and **why**
14+
* Submit a filled out and signed [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) if needed (see below)
15+
* Be patient. We will get to your pull request eventually
16+
17+
If what you are going to work on is a substantial change, please first ask the core team
18+
of their opinion on [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).
19+
20+
21+
## Code of Conduct
22+
23+
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
24+
25+
26+
## Contributor Agreement
27+
28+
If you want to contribute a non-trivial change, please submit a signed copy of our
29+
[Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) around the time
30+
you submit your pull request. This will make it much easier (in some cases, possible)
31+
for the RabbitMQ team at Pivotal to merge your contribution.
32+
33+
34+
## Where to Ask Questions
35+
36+
If something isn't clear, feel free to ask on our [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).

HTML_PERFORMANCE_TOOLS.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,19 +344,25 @@ $ python -m SimpleHTTPServer
344344
As an alternative, from the root directory of the binary distribution,
345345
you can launch a Java-based web server:
346346

347-
$ bin/runjava com.rabbitmq.examples.WebServer
347+
```
348+
bin/runjava com.rabbitmq.examples.WebServer
349+
```
348350

349351
The latter command starts a web server listening on port 8080, with the
350352
`html` directory as its base directory. You can then see the included
351353
sample at http://localhost:8080/examples/sample.html. To change these defaults:
352354

353-
$ bin/runjava com.rabbitmq.examples.WebServer ./other-base-dir 9090
355+
```
356+
bin/runjava com.rabbitmq.examples.WebServer ./other-base-dir 9090
357+
```
354358

355359
At last, if you want a quick preview of your results (same layout
356360
as the first 'consume' scenario above), ensure the scenario name is
357361
'benchmark' in the result file and launch the following command:
358362

363+
```
359364
$ bin/runjava com.rabbitmq.examples.BenchmarkResults my-result-file.js
365+
```
360366

361367
The latter command will start a web server on port 8080 and open
362368
a browser window to display the results.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ HTML page. Learn more [here](HTML_PERFORMANCE_TOOLS.md).
2424

2525
## Contributing
2626

27-
TODO
27+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for an overview of the development process.
2828

2929
## Building
3030

0 commit comments

Comments
 (0)