Skip to content

Commit b239ab1

Browse files
authored
Add CONTRIBUTING.md (#585)
## Changes <!-- Summary of your changes that are easy to understand --> ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [ ] `make test` run locally - [ ] `make fmt` applied - [ ] relevant integration tests applied
1 parent 33b209b commit b239ab1

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
We happily welcome contributions to the Databricks SDK for Python. We use [GitHub Issues](github.com/databricks/databricks-sdk-py/issues) to track community reported issues and [GitHub Pull Requests](https://github.com/databricks/databricks-sdk-py/pulls) for accepting changes.
2+
Contributions are licensed on a license-in/license-out basis.
3+
4+
# Contributing Guide
5+
6+
## Communication
7+
Before starting work on a major feature, please open a GitHub issue. We will make sure no one else is already working on it and that it is aligned with the goals of the project.
8+
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
9+
We will use the GitHub issue to discuss the feature and come to agreement.
10+
This is to prevent your time being wasted, as well as ours.
11+
The GitHub review process for major features is also important so that organizations with commit access can come to agreement on design.
12+
If it is appropriate to write a design document, the document must be hosted either in the GitHub tracking issue, or linked to from the issue and hosted in a world-readable location.
13+
Small patches and bug fixes don't need prior communication.
14+
15+
## Coding Style
16+
Code style is enforced by a formatter check in your pull request. We use [yapf](https://github.com/google/yapf) to format our code. Run `make fmt` to ensure your code is properly formatted prior to raising a pull request.
17+
18+
## Signed Commits
19+
This repo requires all contributors to sign their commits. To configure this, you can follow [Github's documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) to create a GPG key, upload it to your Github account, and configure your git client to sign commits.
20+
21+
## Sign your work
22+
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
23+
24+
```
25+
Developer Certificate of Origin
26+
Version 1.1
27+
28+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
29+
1 Letterman Drive
30+
Suite D4700
31+
San Francisco, CA, 94129
32+
33+
Everyone is permitted to copy and distribute verbatim copies of this
34+
license document, but changing it is not allowed.
35+
36+
37+
Developer's Certificate of Origin 1.1
38+
39+
By making a contribution to this project, I certify that:
40+
41+
(a) The contribution was created in whole or in part by me and I
42+
have the right to submit it under the open source license
43+
indicated in the file; or
44+
45+
(b) The contribution is based upon previous work that, to the best
46+
of my knowledge, is covered under an appropriate open source
47+
license and I have the right under that license to submit that
48+
work with modifications, whether created in whole or in part
49+
by me, under the same open source license (unless I am
50+
permitted to submit under a different license), as indicated
51+
in the file; or
52+
53+
(c) The contribution was provided directly to me by some other
54+
person who certified (a), (b) or (c) and I have not modified
55+
it.
56+
57+
(d) I understand and agree that this project and the contribution
58+
are public and that a record of the contribution (including all
59+
personal information I submit with it, including my sign-off) is
60+
maintained indefinitely and may be redistributed consistent with
61+
this project or the open source license(s) involved.
62+
```
63+
64+
Then you just add a line to every git commit message:
65+
66+
```
67+
Signed-off-by: Joe Smith <[email protected]>
68+
```
69+
70+
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with git commit -s.
71+
You must use your real name (sorry, no pseudonyms or anonymous contributions).

0 commit comments

Comments
 (0)