Skip to content

Commit e27db53

Browse files
committed
Polish CONTRIBUTING
1 parent 354632a commit e27db53

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

CONTRIBUTING.adoc

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,37 @@
33
Spring Java Format is released under the Apache 2.0 license.
44
If you would like to contribute something, or simply want to hack on the code this document should help you get started.
55

6+
7+
68
== Code of Conduct
79
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
810
By participating, you are expected to uphold this code.
911
Please report unacceptable behavior to [email protected].
1012

13+
14+
1115
== Sign the Contributor License Agreement
1216
Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement].
1317
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.
1418
Active contributors might be asked to join the core team, and given the ability to merge pull requests.
1519

16-
== Working with the code
20+
21+
22+
== Working With the Code
1723
If you don't have an IDE preference we would recommend that you use
1824
https://spring.io/tools/sts[Spring Tools Suite] or
1925
https://eclipse.org[Eclipse] when working with the code. We use the
2026
https://eclipse.org/m2e/[M2Eclipse] eclipse plugin for maven support. Other IDEs and tools
2127
should also work without issue.
2228

23-
=== Building from source
29+
30+
31+
=== Building From Source
2432
To build the source you will need to install JDK 1.8.
2533

26-
==== Default build
34+
35+
36+
==== Default Build
2737
The project can be built from the root directory using the standard maven command:
2838

2939
[indent=0]
@@ -33,7 +43,9 @@ The project can be built from the root directory using the standard maven comman
3343

3444
NOTE: You may need to increase the amount of memory available to Maven by setting a `MAVEN_OPTS` environment variable with the value `-Xmx512m`
3545

36-
=== Importing into eclipse
46+
47+
48+
=== Importing Into Eclipse
3749
You can import the code into any Eclipse based distribution as long as it had the https://eclipse.org/m2e/[M2Eclipse] eclipse plugin.
3850
If you don't already have m2eclipse installed it is available from the "Eclipse marketplace".
3951

@@ -46,10 +58,14 @@ Once imported, you can apply eclipse settings by running:
4658

4759
NOTE: You'll need to close the `spring-javaformat-formatter-eclipse` and `spring-javaformat-formatter-eclipse-runtime` projects following import since they contain rewritten packages that aren't supported by the IDE
4860

49-
=== Importing into other IDEs
61+
62+
63+
=== Importing Into Other IDEs
5064
Maven is well supported by most Java IDEs. Refer to your vendor documentation.
5165

52-
== Understanding the code
66+
67+
68+
== Understanding the Code
5369
There are quite a few moving parts to this project and the build is quite complex.
5470
At the top level there are 5 projects:
5571

0 commit comments

Comments
 (0)