-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #193 from rareddy/license-add
adding dco.txt
- Loading branch information
Showing
2 changed files
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,61 @@ | ||
## Contributing to the project | ||
|
||
**Want to contribute? Great!** | ||
We try to make it easy, and all contributions, even the smaller ones, are more than welcome. | ||
This includes bug reports, fixes, documentation, examples... | ||
But first, read this page (including the small print at the end). | ||
|
||
## Legal | ||
|
||
All original contributions to kafka-admin-api are licensed under the | ||
[ASL - Apache License](https://www.apache.org/licenses/LICENSE-2.0), | ||
version 2.0 or later, or, if another license is specified as governing the file or directory being | ||
modified, such other license. | ||
|
||
All contributions are subject to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). | ||
The DCO text is also included verbatim in the [dco.txt](dco.txt) file in the root directory of the repository. | ||
|
||
## Reporting an issue | ||
|
||
This project uses GitHub issues to manage the issues. Open an issue directly in GitHub. you can also open JIRA issues at https://issues.redhat.com/browse/MGDSTRM | ||
|
||
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. | ||
|
||
## Before you contribute | ||
|
||
To contribute, use GitHub Pull Requests, from your **own** fork. | ||
|
||
Also, make sure you have set up your Git authorship correctly: | ||
|
||
``` | ||
git config --global user.name "Your Full Name" | ||
git config --global user.email [email protected] | ||
``` | ||
|
||
If you use different computers to contribute, please make sure the name is the same on all your computers. | ||
|
||
We use this information to acknowledge your contributions in release announcements. | ||
|
||
### Code reviews | ||
|
||
All submissions, including submissions by project members, need to be reviewed by at least two kafka-admin-api committers before being merged. | ||
|
||
[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. | ||
|
||
### Coding Guidelines | ||
|
||
* We decided to disallow `@author` tags in the Javadoc: they are hard to maintain | ||
* 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. | ||
|
||
### Continuous Integration | ||
|
||
kafka-admin-api CI is based on GitHub Actions, which means that everyone has the ability to automatically execute CI in their forks as part of the process of making changes. We ask that all non-trivial changes go through this process, so that the contributor gets immediate feedback, while at the same time keeping our CI fast and healthy for everyone. | ||
|
||
### Tests and documentation are not optional | ||
|
||
Don't forget to include tests in your pull requests. | ||
Also don't forget the documentation (reference documentation, javadoc...). | ||
|
||
### Installing Checkstyle | ||
|
||
Project uses checkstyle mvn plugin that is executed during `mvn validate` pase. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
1 Letterman Drive | ||
Suite D4700 | ||
San Francisco, CA, 94129 | ||
|
||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
|
||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. |