pgjdbc_r2dbc-postgresql

1
= Contributing to R2DBC
2

3
First off, thank you for taking the time to contribute! 👍 🎉
4

5
== Table of Contents
6

7
* <<code-of-conduct,Code of Conduct>>
8
* <<how-to-contribute,How to Contribute>>
9
** <<discuss,Discuss>>
10
** <<ticket-lifecycle,Ticket Lifecycle>>
11
** <<submit-a-pull-request,Submit a Pull Request>>
12
* <<source-code-style,Source Code Style>>
13

14
[[code-of-conduct]]
15
== Code of Conduct
16

17
This project is governed by the link:https://github.com/pgjdbc/r2dbc-postgresql/blob/main/.github/CODE_OF_CONDUCT.adoc[Code of Conduct].
18
By participating you are expected to uphold this code.
19
Please report unacceptable behavior to r2dbc@googlegroups.com.
20

21
[[how-to-contribute]]
22
== How to Contribute
23

24
[[discuss]]
25
=== Discuss
26

27
If you have a question, check https://stackoverflow.com/tags/r2dbc[StackOverflow] using the https://stackoverflow.com/tags/r2dbc[r2dbc] tag or the link:https://groups.google.com/forum/#!forum/r2dbc[mailing list]
28
Find an existing discussion or start a new one if necessary.
29

30
If you suspect an issue, perform a search in the GitHub tracker of the R2DBC project, using a few different keywords.
31
When you find related issues and discussions, prior or current, it helps you to learn and it helps us to make a decision.
32

33
=== Create a Ticket
34

35
Reporting an issue or making a feature request is a great way to contribute.
36
Your feedback and the conversations that result from it provide a continuous flow of ideas.
37

38
Before you create a ticket, please take the time to <<discuss,research first>>.
39

40
If creating a ticket after a discussion on StackOverflow or the Mailing List, please provide a self-sufficient description in the ticket.
41
We understand this is extra work but the issue tracker is an important place of record for design discussions and decisions that can often be referenced long after the fix version, for example to revisit decisions, to understand the origin of a feature, and so on.
42

43
When ready create a ticket in GitHub.
44

45
[[ticket-lifecycle]]
46
=== Ticket Lifecycle
47

48
When an issue is first created, it may not be assigned and will not have a fix version.
49
Within a day or two, the issue is assigned to a specific committer.
50
The committer will then review the issue, ask for further information if needed, and based on the findings, the issue is either assigned a fix
51
version or rejected.
52

53
When a fix is ready, the issue is marked "Resolved" and may still be re-opened.
54
Once the fix is released, you will need to create a new, related ticket with a fresh description, if necessary.
55

56
[[submit-a-pull-request]]
57
=== Submit a Pull Request
58

59
You can contribute a source code change by submitting a pull request.
60

61
1. For all but the most trivial of contributions, please <<create-a-ticket,create a ticket>>.
62
The purpose of the ticket is to understand and discuss the underlying issue or feature.
63
We use the JIRA issue tracker as the preferred place of record for conversations and conclusions.
64
In that sense discussions directly under a PR are more implementation detail oriented and transient in nature.
65

66
2. Always check out the `main` branch and submit pull requests against it.
67
Backports to prior versions will be considered on a case-by-case basis and reflected as the fix version in the issue tracker.
68

69
3. Use short branch names, preferably based on the GitHub issue (e.g. `gh-1234`), or otherwise using succinct, lower-case, dash (-) delimited names, such as `fix-warnings`.
70

71
4. Choose the granularity of your commits consciously and squash commits that represent multiple edits or corrections of the same logical change.
72
See https://git-scm.com/book/en/Git-Tools-Rewriting-History[Rewriting History section of Pro Git] for an overview of streamlining commit history.
73

74
5. Format commit messages using 55 characters for the subject line, 72 lines for the description, followed by related issues, e.g. `[resolves #1234]`
75
See the https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines[Commit Guidelines section of Pro Git] for best practices around commit messages and use `git log` to see some examples.
76

77
6. List the GitHub issue number in the PR description.
78

79
If accepted, your contribution may be heavily modified as needed prior to merging.
80
You will likely retain author attribution for your Git commits granted that the bulk of your changes remain intact.
81
You may also be asked to rework the submission.
82

83
If asked to make corrections, simply push the changes against the same branch, and your pull request will be updated.
84
In other words, you do not need to create a new pull request when asked to make changes.
85

86

87
[[source-code-style]]
88
== Source Code Style
89

90
We provide an IntelliJ link:https://github.com/pgjdbc/r2dbc-postgresql/blob/main/intellij-style.xml[IDEA code formatting configuration] that defines the source file coding standards.
91
Import and use the provided configuration to avoid formatting changes in pull requests.
92