Skip to content

Commit 3a5ff1e

Browse files
committed
Added dco and contributing docs. Fixes Apicurio/apicurio-tasks#152
1 parent 7abb2ec commit 3a5ff1e

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed

CONTRIBUTING.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributing guide
2+
3+
**Want to contribute? Great!**
4+
We try to make it easy, and all contributions, even the smaller ones, are more than welcome.
5+
This includes bug reports, fixes, documentation, examples...
6+
But first, read this page (including the small print at the end).
7+
8+
* [Legal](#legal)
9+
* [Reporting an issue](#reporting-an-issue)
10+
* [Before you contribute](#before-you-contribute)
11+
+ [Code reviews](#code-reviews)
12+
+ [Coding Guidelines](#coding-guidelines)
13+
+ [Continuous Integration](#continuous-integration)
14+
+ [Tests and documentation are not optional](#tests-and-documentation-are-not-optional)
15+
* [The small print](#the-small-print)
16+
17+
18+
## Legal
19+
20+
All original contributions to Apicurio projects are licensed under the
21+
[ASL - Apache License](https://www.apache.org/licenses/LICENSE-2.0),
22+
version 2.0 or later, or, if another license is specified as governing the file or directory being
23+
modified, such other license.
24+
25+
All contributions are subject to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/).
26+
The DCO text is also included verbatim in the [dco.txt](dco.txt) file in the root directory of the repository.
27+
28+
## Reporting an issue
29+
30+
This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.
31+
32+
If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and what you would expect to see.
33+
Don't forget to indicate your Apicurio Registry, Java, and Maven versions.
34+
35+
## Before you contribute
36+
37+
To contribute, use GitHub Pull Requests, from your **own** fork.
38+
39+
Also, make sure you have set up your Git authorship correctly:
40+
41+
```
42+
git config --global user.name "Your Full Name"
43+
git config --global user.email your.email@example.com
44+
```
45+
46+
If you use different computers to contribute, please make sure the name is the same on all your computers.
47+
48+
We may use this information to acknowledge your contributions!
49+
50+
### Code reviews
51+
52+
All submissions, including submissions by project members, need to be reviewed by at least one Apicurio committer before being merged.
53+
54+
[GitHub Pull Request Review Process](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) is followed for every pull request.
55+
56+
### Coding Guidelines
57+
58+
* We primarily use the Git history to track authorship. GitHub also has [this nice page with your contributions](https://github.com/quarkusio/quarkus/graphs/contributors).
59+
* Please take care to write code that fits with existing code styles. For your convenience we have Formatters and/or Code Templates for both [Eclipse](https://github.com/Apicurio/apicurio-configs/tree/main/eclipse) and [IntelliJ](https://github.com/Apicurio/apicurio-configs/tree/main/intellij).
60+
* Commits should be atomic and semantic. Please properly squash your pull requests before submitting them. Fixup commits can be used temporarily during the review process but things should be squashed at the end to have meaningful commits.
61+
* We typically squash and merge pull requests when they are approved. This tends to keep the commit history a little bit more tidy without placing undue burden on the developers.
62+
63+
### Continuous Integration
64+
65+
Because we are all humans, and to ensure Apicurio Registry is stable for everyone, all changes must pass continuous integration before being merged. Apicurio CI is based on GitHub Actions, which means that pull requests will receive automatic feedback. Please watch out for the results of these workflows to see if your PR passes all tests.
66+
67+
### Tests and documentation are not optional
68+
69+
Don't forget to include tests in your pull requests.
70+
Also don't forget the documentation (reference documentation, javadoc...).
71+
72+
Be sure to test your pull request using all storage variants:
73+
74+
1. SQL storage (using the `-Psql` profile)
75+
2. KafkaSQL storage (using the `-Pkafkasql` profile)
76+
77+
78+
## The small print
79+
80+
This project is an open source project, please act responsibly, be nice, polite and enjoy!
81+

dco.txt

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
1 Letterman Drive
6+
Suite D4700
7+
San Francisco, CA, 94129
8+
9+
Everyone is permitted to copy and distribute verbatim copies of this
10+
license document, but changing it is not allowed.
11+
12+
13+
Developer's Certificate of Origin 1.1
14+
15+
By making a contribution to this project, I certify that:
16+
17+
(a) The contribution was created in whole or in part by me and I
18+
have the right to submit it under the open source license
19+
indicated in the file; or
20+
21+
(b) The contribution is based upon previous work that, to the best
22+
of my knowledge, is covered under an appropriate open source
23+
license and I have the right under that license to submit that
24+
work with modifications, whether created in whole or in part
25+
by me, under the same open source license (unless I am
26+
permitted to submit under a different license), as indicated
27+
in the file; or
28+
29+
(c) The contribution was provided directly to me by some other
30+
person who certified (a), (b) or (c) and I have not modified
31+
it.
32+
33+
(d) I understand and agree that this project and the contribution
34+
are public and that a record of the contribution (including all
35+
personal information I submit with it, including my sign-off) is
36+
maintained indefinitely and may be redistributed consistent with
37+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)