Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 60 lines (39 sloc) 3.878 kb
6c40282 Dave Syer Add simple readme
dsyer authored
1 This project provides support for using Spring and Java with AMQP, and in particular RabbitMQ.
2
1689754 Dave Syer Re-org assembly filesets and re-use README.md
dsyer authored
3 # Getting Started
6c40282 Dave Syer Add simple readme
dsyer authored
4
c3f6cb8 Dave Syer AMQP-174: updates to poms for 1.0.0
dsyer authored
5 Clone from GIT and then use Maven (2.2.*):
6c40282 Dave Syer Add simple readme
dsyer authored
6
7 $ git clone ...
c3f6cb8 Dave Syer AMQP-174: updates to poms for 1.0.0
dsyer authored
8 $ mvn install -P bootstrap
9
10 Use the `bootstrap` profile only the first time - it enables some
11 repositories that can't be exposed in the poms by default.
6c40282 Dave Syer Add simple readme
dsyer authored
12
1689754 Dave Syer Re-org assembly filesets and re-use README.md
dsyer authored
13 SpringSource ToolSuite users (or Eclipse users with the latest
14 m2eclipse plugin) can import the projects as existing Eclipse
92e59cc Mark Fisher typos in README
markfisher authored
15 projects. There are plenty of interesting integration tests (names
1689754 Dave Syer Re-org assembly filesets and re-use README.md
dsyer authored
16 ending with `IntegrationTests`) to show the features of the
17 framework. Sample applications can be found in the [Spring AMQP
18 Samples](http://github.com/SpringSource/spring-amqp-samples) project.
19
20 Spring AMQP is released under the terms of the Apache Software License Version 2.0 (see license.txt).
21
22
23 ## Distribution Contents
24
25 The binary JARs are available in the 'dist' directory, and the source JARs are in the 'src' directory. The reference manual and javadoc are located in the 'docs' directory.
26
27 ## Changelog
28
29 Lists of issues addressed per release can be found in [JIRA](https://jira.springsource.org/browse/AMQP#selectedTab=com.atlassian.jira.plugin.system.project%3Aversions-panel).
30
31 ## Additional Resources
32
33 * Spring AMQP Homepage: [http://www.springsource.org/spring-amqp]
34 * Spring AMQP Source: [http://github.com/SpringSource/spring-amqp]
35 * Spring AMQP Samples: [http://github.com/SpringSource/spring-amqp-samples]
36 * Spring AMQP Forum: [http://forum.springsource.org/forumdisplay.php?f=74]
37
92c68b3 Dave Syer Add committer agreement link
dsyer authored
38
39 # Contributing to Spring AMQP
40
41 Here are some ways for you to get involved in the community:
42
a8425de Dave Syer Fixed forum link
dsyer authored
43 * Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?f=74) by responding to questions and joining the debate.
92c68b3 Dave Syer Add committer agreement link
dsyer authored
44 * Create [JIRA](https://jira.springsource.org/browse/AMQP) tickets for bugs and new features and comment and vote on the ones that you are interested in.
45 * Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
46 * Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org
47
48 Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
9112c8d Dave Syer Add code convention housekeeping guidleines
dsyer authored
49
50 ## Code Conventions and Housekeeping
51 None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.
9dc8acc Dave Syer Fix formatting in README
dsyer authored
52
9112c8d Dave Syer Add code convention housekeeping guidleines
dsyer authored
53 * Use the Spring Framework code format conventions (import `eclipse-code-formatter.xml` from the root of the project if you are using Eclipse).
54 * Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.
55 * Add the ASF license header comment to all new .java files (copy from existing files in the project)
92e59cc Mark Fisher typos in README
markfisher authored
56 * Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
1689754 Dave Syer Re-org assembly filesets and re-use README.md
dsyer authored
57 * Add some Javadocs and, if you change the namespace, some XSD doc elements.
9112c8d Dave Syer Add code convention housekeeping guidleines
dsyer authored
58 * A few unit tests would help a lot as well - someone has to do it.
a1debcc Dave Syer Add note about rebase
dsyer authored
59 * If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
Something went wrong with that request. Please try again.