Skip to content

Add DCO to CONTRIBUTING.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 29 commits into from
Aug 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
a50cdc1
Add DCO
susodapop Jul 1, 2022
209b21b
Add preamble
susodapop Jul 1, 2022
bb88524
add pull request template
susodapop Jul 1, 2022
fc91fea
Reorganise CONTRIBUTING.md
susodapop Jul 1, 2022
6976201
Fix typo in URLs
susodapop Jul 1, 2022
88b7f02
Rebased on latest main
susodapop Jul 15, 2022
416acc4
Fix format error during rebase onto latest `main`
susodapop Jul 15, 2022
16b438c
Add automatic DCO Check failure notification action.
susodapop Jul 15, 2022
a41e451
Revert "Add automatic DCO Check failure notification action."
susodapop Jul 29, 2022
b9b2cb2
Introduce GH Action for automated DCO Check
susodapop Jul 29, 2022
49919d5
Update CONTRIBUTING.md
susodapop Jul 29, 2022
1853805
Test: Attempt to auto-comment failures
susodapop Jul 29, 2022
fe8a688
Experimenting how to get error message from previous check
susodapop Jul 29, 2022
8fdac4f
Previous commit gave me access to the array. Now let's expand it.
susodapop Jul 29, 2022
06bde92
Next attempt to expand out the errors in a GH comment
susodapop Jul 29, 2022
5dcea64
Revert "Next attempt to expand out the errors in a GH comment"
susodapop Jul 29, 2022
6668614
Found extra characters to remove.
susodapop Jul 29, 2022
1c2d2ab
Fake commit to kickoff checks
susodapop Jul 29, 2022
528c8de
Try again
susodapop Jul 29, 2022
e0e54e4
Syntax error
susodapop Jul 29, 2022
3ffb49b
join is not defined
susodapop Jul 29, 2022
af955d5
steps is not defined
susodapop Jul 29, 2022
9f82f81
Unexpected token
susodapop Jul 29, 2022
e5054be
Try adding quotation marks
susodapop Jul 29, 2022
7380e73
With join again
susodapop Jul 29, 2022
ef7829b
Check if .error contains any info
susodapop Jul 29, 2022
71a68b8
Provide generic message on failure
susodapop Jul 29, 2022
deabb18
Clarify message formatting.
susodapop Jul 29, 2022
7a64655
More formatting
susodapop Jul 29, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- We welcome contributions. All patches must include a sign-off. Please see CONTRIBUTING.md for details -->


## What type of PR is this?
<!-- Check all that apply, delete what doesn't apply. -->

- [ ] Refactor
- [ ] Feature
- [ ] Bug Fix
- [ ] Other

## Description

## How is this tested?

- [ ] Unit tests
- [ ] E2E Tests
- [ ] Manually
- [ ] N/A

<!-- If Manually, please describe. -->

## Related Tickets & Documents
25 changes: 25 additions & 0 deletions .github/workflows/dco-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: DCO Check

on: [pull_request]

jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Check for DCO
id: dco-check
uses: tisonkun/[email protected]
- name: Comment about DCO status
uses: actions/github-script@v6
if: ${{ failure() }}
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `Thanks for your contribution! To satisfy the DCO policy in our \
[contributing guide](https://github.com/databricks/databricks-sql-python/blob/main/CONTRIBUTING.md) \
every commit message must include a sign-off message. One or more of your commits is missing this message. \
You can reword previous commit messages with an interactive rebase (\`git rebase -i main\`).`
})
80 changes: 69 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,73 @@
# Contributing
# Contributing Guide

To contribute to this repository, fork it and send pull requests.
We happily welcome contributions to the `databricks-sql-connector` package. We use [GitHub Issues](https://github.com/databricks/databricks-sql-python/issues) to track community reported issues and [GitHub Pull Requests](https://github.com/databricks/databricks-sql-python/pulls) for accepting changes.

Contributions are licensed on a license-in/license-out basis.

## Communication
Before starting work on a major feature, please reach out to us via GitHub, Slack, email, etc. We will make sure no one else is already working on it and ask you to open a GitHub issue.
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
We will use the GitHub issue to discuss the feature and come to agreement.
This is to prevent your time being wasted, as well as ours.
The GitHub review process for major features is also important so that organizations with commit access can come to agreement on design.
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.
Specifically, if the goal is to add a new extension, please read the extension policy.
Small patches and bug fixes don't need prior communication.

## Coding Style
We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) with one exception: lines can be up to 100 characters in length, not 79.

## Sign your work
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):

```
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.
```

Then you just add a line to every git commit message:

```
Signed-off-by: Joe Smith <[email protected]>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
```

If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.

## Set up your environment

Expand Down Expand Up @@ -67,12 +134,3 @@ poetry run python3 -m black src --check
Remove the `--check` flag to write reformatted files to disk.

To simplify reviews you can format your changes in a separate commit.
## Pull Request Process

1. Update the [CHANGELOG.md](README.md) or similar documentation with details of changes you wish to make, if applicable.
2. Add any appropriate tests.
3. Make your code or other changes.
4. Review guidelines such as
[How to write the perfect pull request][github-perfect-pr], thanks!

[github-perfect-pr]: https://blog.github.com/2015-01-21-how-to-write-the-perfect-pull-request/