|
|
|
@ -66,7 +66,7 @@ automatically when you submit a pull request. |
|
|
|
|
|
|
|
|
|
|
|
1. For all but the most trivial of contributions, please [create a ticket](#create-a-ticket). |
|
|
|
1. For all but the most trivial of contributions, please [create a ticket](#create-a-ticket). |
|
|
|
The purpose of the ticket is to understand and discuss the underlying issue or feature. |
|
|
|
The purpose of the ticket is to understand and discuss the underlying issue or feature. |
|
|
|
We use the Github issue tracker as the preferred place of record for conversations and |
|
|
|
We use the GitHub issue tracker as the preferred place of record for conversations and |
|
|
|
conclusions. In that sense discussions directly under a PR are more implementation detail |
|
|
|
conclusions. In that sense discussions directly under a PR are more implementation detail |
|
|
|
oriented and transient in nature. |
|
|
|
oriented and transient in nature. |
|
|
|
|
|
|
|
|
|
|
|
@ -75,7 +75,7 @@ oriented and transient in nature. |
|
|
|
Backports to prior versions will be considered on a case-by-case basis and reflected as |
|
|
|
Backports to prior versions will be considered on a case-by-case basis and reflected as |
|
|
|
the fix version in the issue tracker. |
|
|
|
the fix version in the issue tracker. |
|
|
|
|
|
|
|
|
|
|
|
1. Use short branch names, preferably based on the Github issue (e.g. `SPR-1234`), or |
|
|
|
1. Use short branch names, preferably based on the GitHub issue (e.g. `22276`), or |
|
|
|
otherwise using succinct, lower-case, dash (-) delimited names, such as `fix-warnings`. |
|
|
|
otherwise using succinct, lower-case, dash (-) delimited names, such as `fix-warnings`. |
|
|
|
|
|
|
|
|
|
|
|
1. Choose the granularity of your commits consciously and squash commits that represent |
|
|
|
1. Choose the granularity of your commits consciously and squash commits that represent |
|
|
|
@ -84,12 +84,12 @@ multiple edits or corrections of the same logical change. See |
|
|
|
for an overview of streamlining commit history. |
|
|
|
for an overview of streamlining commit history. |
|
|
|
|
|
|
|
|
|
|
|
1. Format commit messages using 55 characters for the subject line, 72 lines for the |
|
|
|
1. Format commit messages using 55 characters for the subject line, 72 lines for the |
|
|
|
description, followed by related issues, e.g. `Issues: SPR-1234, SPR-1235`. |
|
|
|
description, followed by the issue fixed, e.g. `Fixes #22276`. |
|
|
|
See the |
|
|
|
See the |
|
|
|
[Commit Guidelines section of Pro Git](http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines) |
|
|
|
[Commit Guidelines section of Pro Git](http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines) |
|
|
|
for best practices around commit messages and use `git log` to see some examples. |
|
|
|
for best practices around commit messages and use `git log` to see some examples. |
|
|
|
|
|
|
|
|
|
|
|
1. List the Github issue number in the PR description. |
|
|
|
1. List the GitHub issue number in the PR description. |
|
|
|
|
|
|
|
|
|
|
|
If accepted, your contribution may be heavily modified as needed prior to merging. |
|
|
|
If accepted, your contribution may be heavily modified as needed prior to merging. |
|
|
|
You will likely retain author attribution for your Git commits granted that the bulk of |
|
|
|
You will likely retain author attribution for your Git commits granted that the bulk of |
|
|
|
@ -116,7 +116,7 @@ defines the source file coding standards we use along with some IDEA editor sett |
|
|
|
|
|
|
|
|
|
|
|
The reference documentation is in the [src/docs/asciidoc](src/docs/asciidoc) directory and, in |
|
|
|
The reference documentation is in the [src/docs/asciidoc](src/docs/asciidoc) directory and, in |
|
|
|
[Asciidoctor](http://asciidoctor.org/) format. For trivial changes, you may be able to browse, |
|
|
|
[Asciidoctor](http://asciidoctor.org/) format. For trivial changes, you may be able to browse, |
|
|
|
edit source files, and submit directly from Github. |
|
|
|
edit source files, and submit directly from GitHub. |
|
|
|
|
|
|
|
|
|
|
|
When making changes locally, use `./gradlew asciidoctor` and then browse the result under |
|
|
|
When making changes locally, use `./gradlew asciidoctor` and then browse the result under |
|
|
|
`build/asciidoc/html5/index.html`. |
|
|
|
`build/asciidoc/html5/index.html`. |
|
|
|
|