Skip to content

Commit 163dde5

Browse files
committed
docs(contrib): add commit footer info, move legal section to end
1 parent ac7fe0d commit 163dde5

File tree

1 file changed

+52
-18
lines changed

1 file changed

+52
-18
lines changed

CONTRIBUTING.adoc

Lines changed: 52 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,6 @@
33
Thank you for your interest in contributing to UnifiedDB!
44
We welcome all contributions that meet our xref:CODE_OF_CONDUCT.adoc[code of conduct].
55

6-
== Legal
7-
8-
All contributions to UnifiedDB are by default made under the xref:LICENSE[BSD-3-clear license].
9-
Copyrights are held by the specific contributors, and are not tracked by the UnifiedDB project other
10-
than what can be gleaned through git history.
11-
12-
Under special circumstances code may be added under a different license.
13-
For example, code from an existing project may be integrated after careful deliberation.
14-
Any contributions under a different license will receive extra review.
15-
When any contribution is made under a different license, it must be tracked using
16-
https://reuse.software/tutorial/#step-2[a Reuse-compatible identifer].
17-
18-
To keep UnifiedDB open to both private and commercial interests, contributions under a
19-
https://en.wikipedia.org/wiki/copyleft[copyleft license] will never be accepted.
20-
216
== Ways to contribute
227

238
=== Bug Reports
@@ -116,17 +101,40 @@ the impact of the change.
116101

117102
==== Footer
118103

119-
A footer is required when the commit introduces a breaking change or closes a GitHub issue. For example:
104+
A footer is required when the commit introduces a breaking change, closes a GitHub issue,
105+
or has relevant git trailers.
106+
107+
===== Breaking change
108+
109+
When a commit introduces a breaking change to _any_ component, the commit message *must* include
110+
a breaking change note in the footer:
120111

121112
```
122113
BREAKING CHANGE: <breaking change summary>
123114
<BLANK LINE>
124115
<breaking change description + migration instructions>
125-
<BLANK LINE>
126-
<BLANK LINE>
116+
```
117+
118+
==== Linked Issues and PRs
119+
120+
When a commit will close a GitHub Issue, it should be noted in the footer:
121+
122+
```
127123
Fixes #<issue number>
124+
Closes #<issue numer>
128125
```
129126

127+
==== Git trailers
128+
129+
When any of the extra information is relevant to a commit, it should be marked with a git trailer.
130+
Standard trailers for UnifiedDB include:
131+
132+
[cols="1,2,3"]
133+
|===
134+
| Key | Value format | Description
135+
| Co-authored-by | Firstname Lastname <email> | A person, other than the committer, that authored part of the patch
136+
|===
137+
130138
==== Examples
131139

132140
The following are examples of good commit messages:
@@ -153,13 +161,39 @@ feat(ruby-db): add Sorbet type checking
153161
Add Sorbet type signatures to ruby-db code, and run Sorbet type check in CI.
154162

155163
Closes #934
164+
Co-authored-by: Frank the Tank <[email protected]>
156165
```
157166

158167
=== Code review
159168

160169
All Pull Requests must go through the code review process.
161170

171+
All Pull Requests require approval by at least one Code Owner.
172+
173+
Code Owners are maintained in `.github/CODEOWNERS`.
162174

163175
== Finding tasks
164176

165177
If you are looking to contribute but are unsure what to do, browse through the https://github.com/riscv-software-src/riscv-unified-db/issues[issues]. We try to keep them tagged by area and mark easier tasks with "good first issue".
178+
179+
== Legal
180+
181+
All contributions to UnifiedDB are by default made under the xref:LICENSE[BSD-3-clear license].
182+
Copyrights are held by the specific contributors, and are not tracked by the UnifiedDB project other
183+
than what can be gleaned through git history.
184+
185+
Under special circumstances code may be added under a different license.
186+
For example, code from an existing project may be integrated after careful deliberation.
187+
Any contributions under a different license will receive extra review.
188+
When any contribution is made under a different license, it must be tracked using
189+
https://reuse.software/tutorial/#step-2[a Reuse-compatible identifer].
190+
191+
To keep UnifiedDB open to both private and commercial interests, contributions under a
192+
https://en.wikipedia.org/wiki/copyleft[copyleft license] will never be accepted.
193+
194+
== Maintainers
195+
196+
The current maintainers for UnifiedDB are:
197+
198+
* Derek Hower (@dhower-qc)
199+
* Paul Clarke (@ThinkOpenly)

0 commit comments

Comments
 (0)