Skip to content

Commit c38d18a

Browse files
committed
Polishing
See gh-563.
1 parent fb9fcac commit c38d18a

File tree

4 files changed

+39
-372
lines changed

4 files changed

+39
-372
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.1/apache-maven-3.6.1-bin.zip
1+
distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip

README.adoc

Lines changed: 36 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -238,9 +238,7 @@ public class AppConfig {
238238

239239
==== Build requirements for Vault
240240

241-
Spring Vault requires SSL certificates and a running
242-
Vault instance listening on `localhost:8200`. Certificates and the Vault
243-
setup are scripted, the scripts are located in `src/test/bash`.
241+
Spring Vault requires SSL certificates and a running Vault instance listening on `localhost:8200`.Certificates and the Vault setup are scripted, the scripts are located in `src/test/bash`.
244242

245243
The following scripts need to be run prior to building the project for the tests to pass.
246244

@@ -255,66 +253,42 @@ Changes to the documentation should be made to the adocs found under `src/main/a
255253

256254
To build the source you will need to install JDK 1.6.
257255

258-
Spring Vault uses Maven for most build-related activities, and you
259-
should be able to get off the ground quite quickly by cloning the
260-
project you are interested in and typing
256+
Spring Vault uses Maven for most build-related activities, and you should be able to get off the ground quite quickly by cloning the project you are interested in and typing
261257

262258
----
263259
$ ./mvnw install
264260
----
265261

266-
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
267-
in place of `./mvnw` in the examples below. If you do that you also
268-
might need to add `-P spring` if your local Maven settings do not
269-
contain repository declarations for spring pre-release artifacts.
270-
271-
NOTE: Be aware that you might need to increase the amount of memory
272-
available to Maven by setting a `MAVEN_OPTS` environment variable with
273-
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
274-
the `.mvn` configuration, so if you find you have to do it to make a
275-
build succeed, please raise a ticket to get the settings added to
276-
source control.
277-
278-
For hints on how to build the project look in `.travis.yml` if there
279-
is one. There should be a "script" and maybe "install" command. Also
280-
look at the "services" section to see if any services need to be
281-
running locally (e.g. mongo or rabbit). Ignore the git-related bits
282-
that you might find in "before_install" since they're related to setting git
283-
credentials and you already have those.
262+
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command in place of `./mvnw` in the examples below.If you do that you also might need to add `-P spring` if your local Maven settings do not contain repository declarations for spring pre-release artifacts.
263+
264+
NOTE: Be aware that you might need to increase the amount of memory available to Maven by setting a `MAVEN_OPTS` environment variable with a value like `-Xmx512m -XX:MaxPermSize=128m`.We try to cover this in the `.mvn` configuration, so if you find you have to do it to make a build succeed, please raise a ticket to get the settings added to source control.
265+
266+
For hints on how to build the project look in `.travis.yml` if there is one.There should be a "script" and maybe "install" command.Also look at the "services" section to see if any services need to be running locally (e.g. mongo or rabbit).Ignore the git-related bits that you might find in "before_install" since they're related to setting git credentials and you already have those.
284267

285268
NOTE: If all else fails, build with the command from `.travis.yml` (usually
286269
`./mvnw install`).
287270

288271
=== Documentation
289272

290-
The module has a "distribute" profile, and if you switch
291-
that on it will try to build asciidoc sources from
273+
The module has a "distribute" profile, and if you switch that on it will try to build asciidoc sources from
292274
`src/main/asciidoc`.
293275

294276
=== Working with the code
277+
295278
If you don't have an IDE preference we would recommend that you use
296279
https://www.springsource.com/developer/sts[Spring Tools Suite] or
297-
https://eclipse.org[Eclipse] when working with the code. We use the
298-
https://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools
299-
should also work without issue as long as they use Maven 3.3.3 or better.
280+
https://eclipse.org[Eclipse] when working with the code.We use the
281+
https://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support.Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better.
300282

301283
==== Importing into eclipse with m2eclipse
302-
We recommend the https://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with
303-
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
304-
marketplace".
305-
306-
NOTE: Older versions of m2e do not support Maven 3.3, so once the
307-
projects are imported into Eclipse you will also need to tell
308-
m2eclipse to use the right profile for the projects. If you
309-
see many different errors related to the POMs in the projects, check
310-
that you have an up to date installation. If you can't upgrade m2e,
311-
add the "spring" profile to your `settings.xml`. Alternatively you can
312-
copy the repository settings from the "spring" profile of the parent
313-
pom into your `settings.xml`.
284+
285+
We recommend the https://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with eclipse.If you don't already have m2eclipse installed it is available from the "eclipse marketplace".
286+
287+
NOTE: Older versions of m2e do not support Maven 3.3, so once the projects are imported into Eclipse you will also need to tell m2eclipse to use the right profile for the projects.If you see many different errors related to the POMs in the projects, check that you have an up to date installation.If you can't upgrade m2e, add the "spring" profile to your `settings.xml`.Alternatively you can copy the repository settings from the "spring" profile of the parent pom into your `settings.xml`.
314288

315289
==== Importing into eclipse without m2eclipse
316-
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
317-
following command:
290+
291+
If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command:
318292

319293
[indent=0]
320294
----
@@ -326,45 +300,33 @@ from the `file` menu.
326300

327301
== Contributing
328302

329-
Spring Vault is released under the non-restrictive Apache 2.0 license,
330-
and follows a very standard Github development process, using Github
331-
tracker for issues and merging pull requests into master. If you want
332-
to contribute even something trivial please do not hesitate, but
333-
follow the guidelines below.
303+
Spring Vault 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.
334304

335305
=== Sign the Contributor License Agreement
306+
336307
Before we accept a non-trivial patch or pull request we will need you to sign the
337308
https://cla.pivotal.io/sign/spring[Contributor License Agreement].
338-
Signing the contributor's agreement does not grant anyone commit rights to the main
339-
repository, but it does mean that we can accept your contributions, and you will get an
340-
author credit if we do. Active contributors might be asked to join the core team, and
341-
given the ability to merge pull requests.
309+
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.
342310

343311
=== Code of Conduct
312+
344313
This project adheres to the Contributor Covenant https://github.com/spring-framework/spring-vault/blob/master/CODE_OF_CONDUCT.adoc[code of
345-
conduct]. By participating, you are expected to uphold this code. Please report
346-
unacceptable behavior to [email protected].
314+
conduct].
315+
By participating, you are expected to uphold this code.
316+
Please report unacceptable behavior to [email protected].
347317

348318
=== Code Conventions and Housekeeping
349-
None of these is essential for a pull request, but they will all help. They can also be
350-
added after the original pull request but before a merge.
351-
352-
* Use the Spring Framework code format conventions. If you use Eclipse
353-
you can import formatter settings using the
354-
`eclipse-code-formatter.xml` file from the
355-
https://raw.githubusercontent.com/spring-framework/spring-vault/master/etc/ide/eclipse-code-formatter.xml[project]. If using IntelliJ, you can use the
356-
https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter
357-
Plugin] to import the same file.
319+
320+
None of these is essential for a pull request, but they will all help.
321+
They can also be added after the original pull request but before a merge.
322+
323+
* Spring Vault uses the Spring JavaFormat conventions.
324+
Formatting is applied when running the build through `$ ./mvnw compile`
325+
IDE plugins are available from https://github.com/spring-io/spring-javaformat.
358326
* Make sure all new `.java` files to have a Javadoc class comment with at least an
359-
`@author` tag identifying you, and preferably at least a paragraph on what the class is
360-
for.
361-
* Add the ASF license header comment to all new `.java` files (copy from existing files
362-
in the project)
363-
* Add yourself as an `@author` to the .java files that you modify substantially (more
364-
than cosmetic changes).
327+
`@author` tag identifying you, and preferably at least a paragraph on what the class is for.
328+
* Add the ASF license header comment to all new `.java` files (copy from existing files in the project)
329+
* Add yourself as an `@author` to the .java files that you modify substantially (more than cosmetic changes).
365330
* Please include unit tests.
366-
* If no-one else is using your branch, please rebase it against the current master (or
367-
other target branch in the main project).
368-
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
369-
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
370-
message (where XXXX is the issue number).
331+
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
332+
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], 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).

0 commit comments

Comments
 (0)