A Gateway built on Spring Framework and Spring Boot providing routing and more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

44 lines
2.7 KiB

# Contributing
Spring Cloud is released under the non-restrictive Apache 2.0 license,
and follows a very standard Github development process, using Github
tracker for issues and merging pull requests into master. If you want
to contribute even something trivial please do not hesitate, but
follow the guidelines below.
## Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the
[Contributor License 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 of Conduct
This project adheres to the Contributor Covenant [Code of conduct](https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report
unacceptable behavior to spring-code-of-conduct@pivotal.io.
## 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.
* Use the Spring Framework code format conventions. If you use Eclipse
you can import formatter settings using the
`eclipse-code-formatter.xml` file from the
[Spring Cloud Build](https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml) project. If using IntelliJ, you can use the
URL Cleanup This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener). # HTTP URLs that Could Not Be Fixed These URLs were unable to be fixed. Please review them to see if they can be manually resolved. * [ ] http://httpbin.org:80 (200) with 11 occurrences could not be migrated: ([https](https://httpbin.org:80) result NotSslRecordException). # Fixed URLs ## Fixed But Review Recommended These URLs were fixed, but the https status was not OK. However, the https status was the same as the http request or http redirected to an https URL, so they were migrated. Your review is recommended. * [ ] http://acme.com:8080 (ConnectTimeoutException) with 1 occurrences migrated to: https://acme.com:8080 ([https](https://acme.com:8080) result ConnectTimeoutException). * [ ] http://acme.org (ConnectTimeoutException) with 2 occurrences migrated to: https://acme.org ([https](https://acme.org) result ConnectTimeoutException). * [ ] http://compose.docker.io/ (UnknownHostException) with 1 occurrences migrated to: https://compose.docker.io/ ([https](https://compose.docker.io/) result UnknownHostException). * [ ] http://endpoint (UnknownHostException) with 1 occurrences migrated to: https://endpoint ([https](https://endpoint) result UnknownHostException). * [ ] http://foo.example.com (UnknownHostException) with 1 occurrences migrated to: https://foo.example.com ([https](https://foo.example.com) result UnknownHostException). * [ ] http://myhost (UnknownHostException) with 5 occurrences migrated to: https://myhost ([https](https://myhost) result UnknownHostException). * [ ] http://myhost/abc%20def/get (UnknownHostException) with 1 occurrences migrated to: https://myhost/abc%20def/get ([https](https://myhost/abc%20def/get) result UnknownHostException). * [ ] http://myhost/mypath (UnknownHostException) with 1 occurrences migrated to: https://myhost/mypath ([https](https://myhost/mypath) result UnknownHostException). * [ ] http://myservice (UnknownHostException) with 2 occurrences migrated to: https://myservice ([https](https://myservice) result UnknownHostException). * [ ] http://nameservice (UnknownHostException) with 1 occurrences migrated to: https://nameservice ([https](https://nameservice) result UnknownHostException). * [ ] http://nameservice/foo (UnknownHostException) with 1 occurrences migrated to: https://nameservice/foo ([https](https://nameservice/foo) result UnknownHostException). * [ ] http://originalhost:8080/foo/bar (UnknownHostException) with 2 occurrences migrated to: https://originalhost:8080/foo/bar ([https](https://originalhost:8080/foo/bar) result UnknownHostException). * [ ] http://originalhost:8080/get (UnknownHostException) with 2 occurrences migrated to: https://originalhost:8080/get ([https](https://originalhost:8080/get) result UnknownHostException). * [ ] http://originalhost:8080/get/ (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/get/ ([https](https://originalhost:8080/get/) result UnknownHostException). * [ ] http://originalhost:8080/one/two/three (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/one/two/three ([https](https://originalhost:8080/one/two/three) result UnknownHostException). * [ ] http://originalhost:8080/prefix/get (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/prefix/get ([https](https://originalhost:8080/prefix/get) result UnknownHostException). * [ ] http://originalhost:8080/prefix/get/ (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/prefix/get/ ([https](https://originalhost:8080/prefix/get/) result UnknownHostException). * [ ] http://override-url (UnknownHostException) with 1 occurrences migrated to: https://override-url ([https](https://override-url) result UnknownHostException). * [ ] http://override-url:80 (UnknownHostException) with 1 occurrences migrated to: https://override-url:80 ([https](https://override-url:80) result UnknownHostException). * [ ] http://routedservice:8090/ (UnknownHostException) with 1 occurrences migrated to: https://routedservice:8090/ ([https](https://routedservice:8090/) result UnknownHostException). * [ ] http://routedservice:8090/get (UnknownHostException) with 2 occurrences migrated to: https://routedservice:8090/get ([https](https://routedservice:8090/get) result UnknownHostException). * [ ] http://routedservice:8090/two (UnknownHostException) with 1 occurrences migrated to: https://routedservice:8090/two ([https](https://routedservice:8090/two) result UnknownHostException). * [ ] http://service1 (UnknownHostException) with 1 occurrences migrated to: https://service1 ([https](https://service1) result UnknownHostException). * [ ] http://someuri (UnknownHostException) with 1 occurrences migrated to: https://someuri ([https](https://someuri) result UnknownHostException). * [ ] http://someuri:80 (UnknownHostException) with 1 occurrences migrated to: https://someuri:80 ([https](https://someuri:80) result UnknownHostException). * [ ] http://someurl (UnknownHostException) with 1 occurrences migrated to: https://someurl ([https](https://someurl) result UnknownHostException). * [ ] http://www.uri-destination.org (UnknownHostException) with 1 occurrences migrated to: https://www.uri-destination.org ([https](https://www.uri-destination.org) result UnknownHostException). * [ ] http://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/GatewayFilter.html (301) with 1 occurrences migrated to: https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/GatewayFilter.html ([https](https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/GatewayFilter.html) result 404). * [ ] http://www.puppycrawl.com/dtds/suppressions_1_1.dtd (404) with 1 occurrences migrated to: https://www.puppycrawl.com/dtds/suppressions_1_1.dtd ([https](https://www.puppycrawl.com/dtds/suppressions_1_1.dtd) result 404). ## Fixed Success These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended. * [ ] http://acme.com with 1 occurrences migrated to: https://acme.com ([https](https://acme.com) result 200). * [ ] http://cloud.spring.io/spring-cloud-netflix/ with 5 occurrences migrated to: https://cloud.spring.io/spring-cloud-netflix/ ([https](https://cloud.spring.io/spring-cloud-netflix/) result 200). * [ ] http://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html with 1 occurrences migrated to: https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html ([https](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html) result 200). * [ ] http://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/ServerWebExchange.html with 1 occurrences migrated to: https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/ServerWebExchange.html ([https](https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/ServerWebExchange.html) result 200). * [ ] http://example.com with 8 occurrences migrated to: https://example.com ([https](https://example.com) result 200). * [ ] http://example.org with 34 occurrences migrated to: https://example.org ([https](https://example.org) result 200). * [ ] http://httpbin.org with 1 occurrences migrated to: https://httpbin.org ([https](https://httpbin.org) result 200). * [ ] http://projects.spring.io/spring-cloud/ with 1 occurrences migrated to: https://projects.spring.io/spring-cloud/ ([https](https://projects.spring.io/spring-cloud/) result 200). * [ ] http://projects.spring.io/spring-security/ with 2 occurrences migrated to: https://projects.spring.io/spring-security/ ([https](https://projects.spring.io/spring-security/) result 200). * [ ] http://projects.spring.io/spring-session/ with 2 occurrences migrated to: https://projects.spring.io/spring-session/ ([https](https://projects.spring.io/spring-session/) result 200). * [ ] http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html with 2 occurrences migrated to: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ([https](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) result 200). * [ ] http://docs.spring.io with 1 occurrences migrated to: https://docs.spring.io ([https](https://docs.spring.io) result 301). * [ ] http://plugins.jetbrains.com/plugin/6546 with 2 occurrences migrated to: https://plugins.jetbrains.com/plugin/6546 ([https](https://plugins.jetbrains.com/plugin/6546) result 301). * [ ] http://eclipse.org with 1 occurrences migrated to: https://eclipse.org ([https](https://eclipse.org) result 302). * [ ] http://eclipse.org/m2e/ with 2 occurrences migrated to: https://eclipse.org/m2e/ ([https](https://eclipse.org/m2e/) result 302). * [ ] http://www.springsource.com/developer/sts with 1 occurrences migrated to: https://www.springsource.com/developer/sts ([https](https://www.springsource.com/developer/sts) result 302). # Ignored These URLs were intentionally ignored. * http://localhost with 51 occurrences * http://localhost/ with 2 occurrences * http://localhost/abc with 1 occurrences * http://localhost/get with 10 occurrences * http://localhost/get?a=b with 2 occurrences * http://localhost/get?a=b&c=d with 4 occurrences * http://localhost/get?key with 1 occurrences * http://localhost/getb with 3 occurrences * http://localhost:3001 with 1 occurrences * http://localhost:8008/configserver/foo/default with 1 occurrences * http://localhost:8080/flakey with 1 occurrences * http://localhost:8080/get with 6 occurrences * http://localhost:8080/upload with 1 occurrences * http://localhost:9000/foos/ with 4 occurrences * http://localhost:9080 with 1 occurrences * http://localhost:9994 with 3 occurrences
6 years ago
[Eclipse Code Formatter Plugin](https://plugins.jetbrains.com/plugin/6546) to import the same file.
* 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.
* Add the ASF license header comment to all new `.java` files (copy from existing files
in the project)
* Add yourself as an `@author` to the .java files that you modify substantially (more
than cosmetic changes).
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
* A few unit tests would help a lot as well -- someone has to do it.
* If no-one else is using your branch, please rebase it against the current master (or
other target branch in the main project).
URL Cleanup This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener). # HTTP URLs that Could Not Be Fixed These URLs were unable to be fixed. Please review them to see if they can be manually resolved. * [ ] http://httpbin.org:80 (200) with 11 occurrences could not be migrated: ([https](https://httpbin.org:80) result NotSslRecordException). # Fixed URLs ## Fixed But Review Recommended These URLs were fixed, but the https status was not OK. However, the https status was the same as the http request or http redirected to an https URL, so they were migrated. Your review is recommended. * [ ] http://acme.com:8080 (ConnectTimeoutException) with 1 occurrences migrated to: https://acme.com:8080 ([https](https://acme.com:8080) result ConnectTimeoutException). * [ ] http://acme.org (ConnectTimeoutException) with 2 occurrences migrated to: https://acme.org ([https](https://acme.org) result ConnectTimeoutException). * [ ] http://compose.docker.io/ (UnknownHostException) with 1 occurrences migrated to: https://compose.docker.io/ ([https](https://compose.docker.io/) result UnknownHostException). * [ ] http://endpoint (UnknownHostException) with 1 occurrences migrated to: https://endpoint ([https](https://endpoint) result UnknownHostException). * [ ] http://foo.example.com (UnknownHostException) with 1 occurrences migrated to: https://foo.example.com ([https](https://foo.example.com) result UnknownHostException). * [ ] http://myhost (UnknownHostException) with 5 occurrences migrated to: https://myhost ([https](https://myhost) result UnknownHostException). * [ ] http://myhost/abc%20def/get (UnknownHostException) with 1 occurrences migrated to: https://myhost/abc%20def/get ([https](https://myhost/abc%20def/get) result UnknownHostException). * [ ] http://myhost/mypath (UnknownHostException) with 1 occurrences migrated to: https://myhost/mypath ([https](https://myhost/mypath) result UnknownHostException). * [ ] http://myservice (UnknownHostException) with 2 occurrences migrated to: https://myservice ([https](https://myservice) result UnknownHostException). * [ ] http://nameservice (UnknownHostException) with 1 occurrences migrated to: https://nameservice ([https](https://nameservice) result UnknownHostException). * [ ] http://nameservice/foo (UnknownHostException) with 1 occurrences migrated to: https://nameservice/foo ([https](https://nameservice/foo) result UnknownHostException). * [ ] http://originalhost:8080/foo/bar (UnknownHostException) with 2 occurrences migrated to: https://originalhost:8080/foo/bar ([https](https://originalhost:8080/foo/bar) result UnknownHostException). * [ ] http://originalhost:8080/get (UnknownHostException) with 2 occurrences migrated to: https://originalhost:8080/get ([https](https://originalhost:8080/get) result UnknownHostException). * [ ] http://originalhost:8080/get/ (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/get/ ([https](https://originalhost:8080/get/) result UnknownHostException). * [ ] http://originalhost:8080/one/two/three (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/one/two/three ([https](https://originalhost:8080/one/two/three) result UnknownHostException). * [ ] http://originalhost:8080/prefix/get (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/prefix/get ([https](https://originalhost:8080/prefix/get) result UnknownHostException). * [ ] http://originalhost:8080/prefix/get/ (UnknownHostException) with 1 occurrences migrated to: https://originalhost:8080/prefix/get/ ([https](https://originalhost:8080/prefix/get/) result UnknownHostException). * [ ] http://override-url (UnknownHostException) with 1 occurrences migrated to: https://override-url ([https](https://override-url) result UnknownHostException). * [ ] http://override-url:80 (UnknownHostException) with 1 occurrences migrated to: https://override-url:80 ([https](https://override-url:80) result UnknownHostException). * [ ] http://routedservice:8090/ (UnknownHostException) with 1 occurrences migrated to: https://routedservice:8090/ ([https](https://routedservice:8090/) result UnknownHostException). * [ ] http://routedservice:8090/get (UnknownHostException) with 2 occurrences migrated to: https://routedservice:8090/get ([https](https://routedservice:8090/get) result UnknownHostException). * [ ] http://routedservice:8090/two (UnknownHostException) with 1 occurrences migrated to: https://routedservice:8090/two ([https](https://routedservice:8090/two) result UnknownHostException). * [ ] http://service1 (UnknownHostException) with 1 occurrences migrated to: https://service1 ([https](https://service1) result UnknownHostException). * [ ] http://someuri (UnknownHostException) with 1 occurrences migrated to: https://someuri ([https](https://someuri) result UnknownHostException). * [ ] http://someuri:80 (UnknownHostException) with 1 occurrences migrated to: https://someuri:80 ([https](https://someuri:80) result UnknownHostException). * [ ] http://someurl (UnknownHostException) with 1 occurrences migrated to: https://someurl ([https](https://someurl) result UnknownHostException). * [ ] http://www.uri-destination.org (UnknownHostException) with 1 occurrences migrated to: https://www.uri-destination.org ([https](https://www.uri-destination.org) result UnknownHostException). * [ ] http://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/GatewayFilter.html (301) with 1 occurrences migrated to: https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/GatewayFilter.html ([https](https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/GatewayFilter.html) result 404). * [ ] http://www.puppycrawl.com/dtds/suppressions_1_1.dtd (404) with 1 occurrences migrated to: https://www.puppycrawl.com/dtds/suppressions_1_1.dtd ([https](https://www.puppycrawl.com/dtds/suppressions_1_1.dtd) result 404). ## Fixed Success These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended. * [ ] http://acme.com with 1 occurrences migrated to: https://acme.com ([https](https://acme.com) result 200). * [ ] http://cloud.spring.io/spring-cloud-netflix/ with 5 occurrences migrated to: https://cloud.spring.io/spring-cloud-netflix/ ([https](https://cloud.spring.io/spring-cloud-netflix/) result 200). * [ ] http://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html with 1 occurrences migrated to: https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html ([https](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html) result 200). * [ ] http://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/ServerWebExchange.html with 1 occurrences migrated to: https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/ServerWebExchange.html ([https](https://docs.spring.io/spring/docs/5.0.x/javadoc-api/org/springframework/web/server/ServerWebExchange.html) result 200). * [ ] http://example.com with 8 occurrences migrated to: https://example.com ([https](https://example.com) result 200). * [ ] http://example.org with 34 occurrences migrated to: https://example.org ([https](https://example.org) result 200). * [ ] http://httpbin.org with 1 occurrences migrated to: https://httpbin.org ([https](https://httpbin.org) result 200). * [ ] http://projects.spring.io/spring-cloud/ with 1 occurrences migrated to: https://projects.spring.io/spring-cloud/ ([https](https://projects.spring.io/spring-cloud/) result 200). * [ ] http://projects.spring.io/spring-security/ with 2 occurrences migrated to: https://projects.spring.io/spring-security/ ([https](https://projects.spring.io/spring-security/) result 200). * [ ] http://projects.spring.io/spring-session/ with 2 occurrences migrated to: https://projects.spring.io/spring-session/ ([https](https://projects.spring.io/spring-session/) result 200). * [ ] http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html with 2 occurrences migrated to: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ([https](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) result 200). * [ ] http://docs.spring.io with 1 occurrences migrated to: https://docs.spring.io ([https](https://docs.spring.io) result 301). * [ ] http://plugins.jetbrains.com/plugin/6546 with 2 occurrences migrated to: https://plugins.jetbrains.com/plugin/6546 ([https](https://plugins.jetbrains.com/plugin/6546) result 301). * [ ] http://eclipse.org with 1 occurrences migrated to: https://eclipse.org ([https](https://eclipse.org) result 302). * [ ] http://eclipse.org/m2e/ with 2 occurrences migrated to: https://eclipse.org/m2e/ ([https](https://eclipse.org/m2e/) result 302). * [ ] http://www.springsource.com/developer/sts with 1 occurrences migrated to: https://www.springsource.com/developer/sts ([https](https://www.springsource.com/developer/sts) result 302). # Ignored These URLs were intentionally ignored. * http://localhost with 51 occurrences * http://localhost/ with 2 occurrences * http://localhost/abc with 1 occurrences * http://localhost/get with 10 occurrences * http://localhost/get?a=b with 2 occurrences * http://localhost/get?a=b&c=d with 4 occurrences * http://localhost/get?key with 1 occurrences * http://localhost/getb with 3 occurrences * http://localhost:3001 with 1 occurrences * http://localhost:8008/configserver/foo/default with 1 occurrences * http://localhost:8080/flakey with 1 occurrences * http://localhost:8080/get with 6 occurrences * http://localhost:8080/upload with 1 occurrences * http://localhost:9000/foos/ with 4 occurrences * http://localhost:9080 with 1 occurrences * http://localhost:9994 with 3 occurrences
6 years ago
* When writing a commit message please follow [these conventions](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
message (where XXXX is the issue number).