Add Gradle Enterprise Build Scanning

* README Polishing.

* More README polishing.
This commit is contained in:
Gary Russell
2023-07-27 11:39:35 -04:00
committed by GitHub
parent bcfbce68f0
commit d1dbf10358
2 changed files with 22 additions and 32 deletions

View File

@@ -1,4 +1,5 @@
Spring AMQP [<img src="https://build.spring.io/plugins/servlet/wittified/build-status/AMQP-MAIN">](https://build.spring.io/browse/AAMQP-MAIN)
Spring AMQP [<img src="https://build.spring.io/plugins/servlet/wittified/build-status/AMQP-MAIN">](https://build.spring.io/browse/AAMQP-MAIN)
[![Revved up by Gradle Enterprise](https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.spring.io/scans?search.rootProjectNames=spring-amqp)
===========
This project provides support for using Spring and Java with [AMQP 0.9.1](https://www.rabbitmq.com/amqp-0-9-1-reference.html), and in particular [RabbitMQ](https://www.rabbitmq.com/).
@@ -58,15 +59,14 @@ Once complete, you may then import the projects into Eclipse as usual:
Browse to the *'spring-amqp'* root directory. All projects should import free of errors.
# Using SpringSource Tool Suite™ (STS)
# Using Spring Tools
Using the STS Gradle Support, you can directly import Gradle projects, without having to generate Eclipse metadata first (since STS 2.7.M1). Please make sure you have the Gradle STS Extension installed - Please see the [installation instructions](https://docs.spring.io/sts/docs/latest/reference/html/gradle/installation.html) for details.
Using the STS Gradle Support, you can directly import Gradle projects, without having to generate Eclipse metadata first.
Please see the [Spring Tools Home Page](https://spring.io/tools).
1. Select *File -> Import -> Gradle Project*
1. Select *File -> Import -> Existing Gradle Project*
2. Browse to the Spring AMQP Root Folder
3. Click on **Build Model**
4. Select the projects you want to import
5. Press **Finish**
3. Click on **Finish**
# Using IntelliJ IDEA
@@ -74,45 +74,30 @@ To generate IDEA metadata (.iml and .ipr files), do the following:
./gradlew idea
## Distribution Contents
If you downloaded the full Spring AMQP distribution or if you created the distribution using `./gradlew dist`, you will see the following directory structure:
├── README.md
├── apache-license.txt
├── docs
│ ├── api
│ └── reference
├── epl-license.txt
├── libs
├── notice.txt
└── schema
└── rabbit
The binary JARs and the source code are available in the **libs**. The reference manual and javadocs are located in the **docs** directory.
## Changelog
Lists of issues addressed per release can be found in [JIRA](https://jira.spring.io/browse/AMQP#selectedTab=com.atlassian.jira.plugin.system.project%3Aversions-panel).
Lists of issues addressed per release can be found in [Github](https://github.com/spring-projects/spring-amqp/releases).
## Additional Resources
* [Spring AMQP Homepage](https://www.springsource.org/spring-amqp)
* [Spring AMQP Homepage](https://spring.io/projects/spring-amqp)
* [Spring AMQP Source](https://github.com/SpringSource/spring-amqp)
* [Spring AMQP Samples](https://github.com/SpringSource/spring-amqp-samples)
* [Spring AMQP Forum](https://forum.spring.io/)
* [StackOverflow](https://stackoverflow.com/questions/tagged/spring-amqp)
# Contributing to Spring AMQP
Here are some ways for you to get involved in the community:
* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](https://forum.spring.io/) by responding to questions and joining the debate.
* Create [JIRA](https://jira.spring.io/browse/AMQP) tickets for bugs and new features and comment and vote on the ones that you are interested in.
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://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.
* Watch for upcoming articles on Spring by [subscribing](https://www.springsource.org/node/feed) to springframework.org
* Get involved with the Spring community on Stack Overflow by responding to questions and joining the debate.
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.
* Create Github issues for bugs and new features and comment and vote on the ones that you are interested in.
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/).
If you want to contribute code this way, please reference the specific Github issue you are addressing.
Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://cla.pivotal.io/sign/spring).
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.
## Code Conventions and Housekeeping
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.

View File

@@ -1,3 +1,8 @@
plugins {
id 'com.gradle.enterprise' version '3.13.4'
id 'io.spring.ge.conventions' version '0.0.13'
}
rootProject.name = 'spring-amqp-dist'
include 'spring-amqp'