Skip to content

Commit 493119e

Browse files
Contributing (#882)
* added file CAA.md & added info in CONTRIBUTING.md * first version of the caa-botyml * typo * I believe we shouldn't set a PAT as we're setting the file in the same repository https://github.com/contributor-assistant/github-action/blob/master/README.md#6-adding-personal-access-token-as-a-secret "This PAT should have repo scope and is only required if you have configured to store the signatures in a remote repository/organization." * bump package version to latest * change action name to what looks like it should have been * fix some more things that were off according the documentation --------- Co-authored-by: Andy Boschmans <andy@data-intuitive.com>
1 parent a12d35b commit 493119e

3 files changed

Lines changed: 88 additions & 1 deletion

File tree

.github/workflows/caa-bot.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: "CAA Bot"
2+
on:
3+
issue_comment:
4+
types: [created]
5+
pull_request_target:
6+
types: [opened, closed, synchronize]
7+
8+
# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
9+
permissions:
10+
actions: write
11+
contents: write # this can be 'read' if the signatures are in remote repository
12+
pull-requests: write
13+
statuses: write
14+
15+
jobs:
16+
CLAAssistant:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: "CAA Assistant"
20+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I agree to the Data Intuitive Contributor Assignment Agreement.') || github.event_name == 'pull_request_target'
21+
uses: contributor-assistant/github-action@v2.6.1
22+
env:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
# PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
25+
with:
26+
path-to-signatures: 'signatures/caa.json'
27+
path-to-document: 'https://github.com/viash-io/viash/blob/main/CAA.md'
28+
branch: 'main'
29+
allowlist: 'dependabot[bot],github-actions[bot]'
30+
custom-notsigned-prcomment: 'Thanks for your PR to Viash! 🚀<br><br>Before we can review and merge your code, we need you to accept our Contributor Assignment Agreement (CAA). This assigns the copyright of your contribution to Data Intuitive, while ensuring you retain a license to use your own code anywhere else.<br><br>📝 **How to proceed:**<br>1. Read our short agreement here: [CAA.md](https://github.com/viash-io/viash/blob/main/CAA.md)<br>2. Reply to this comment with the following exact phrase:<br><br>**I agree to the Data Intuitive Contributor Assignment Agreement.**'
31+
custom-pr-sign-comment: 'I have read the Contributor Assignment Agreement and I hereby assign the copyright of my contributions to Data Intuitive.'
32+
custom-allsigned-prcomment: 'All contributors have signed the CAA. Thank you! ✅'

CAA.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributor Assignment Agreement
2+
3+
**Viash – Data Intuitive**
4+
5+
First off, thank you for considering contributing to Viash! We welcome community contributions and are excited to see how we can improve this tool together.
6+
7+
To ensure that Data Intuitive can continue to manage, maintain, and legally protect the Viash project (and to simplify our intellectual property management), we require all contributors to formally assign the copyright of their contributions to Data Intuitive.
8+
9+
Before we can review and merge your Pull Request, you must agree to the following terms. Our automated bot will ask you to confirm this on your first Pull Request.
10+
11+
---
12+
13+
## 1. Assignment of Copyright
14+
15+
By submitting a Contribution (code, documentation, or other materials) to this repository, You hereby assign and transfer to Data Intuitive the entire right, title, and interest (including all rights of copyright) in and to Your Contributions. Data Intuitive becomes the sole owner of the intellectual property of these contributions.
16+
17+
## 2. Representation of Originality
18+
19+
You represent and guarantee that Your Contribution is Your original work and that You have the legal right to assign the copyright to Data Intuitive. If you are contributing on behalf of your employer, you represent that you have the authority to assign these rights on their behalf.
20+
21+
## 3. License Back to You
22+
23+
We don't want to restrict you from using your own brilliant work! Data Intuitive hereby grants You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable license to use, reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the specific Contribution You submitted, for any purpose.
24+
25+
## 4. Moral Rights
26+
27+
To the extent permitted by applicable law, You waive all moral rights in Your Contribution in favor of Data Intuitive.
28+
29+
## 5. No Warranty
30+
31+
Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
32+
33+
## 6. Governing Law
34+
35+
This Agreement is governed by the laws of Belgium. Any disputes arising from or related to this Agreement shall be subject to the exclusive jurisdiction of the courts of Mechelen, Belgium.
36+
37+
---
38+
39+
## How to Agree
40+
41+
When you submit your first Pull Request, our bot will automatically comment on it.
42+
43+
To accept this agreement, simply reply to the bot's comment with the exact following phrase:
44+
45+
`I have read the Contributor Assignment Agreement and I hereby assign the copyright of my contributions to Data Intuitive.`
46+
47+
Once you reply, the status check will pass, and our team will be notified to review your Pull Request. Thank you for making Viash better!
48+
49+
---
50+
51+
*Data Intuitive BV – [hello@data-intuitive.com](mailto:hello@data-intuitive.com)*

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Contributing
22

3-
Welcome to the Viash project, and thank you for considering contributing! We are open to a variety of contributions, including documentation updates, bug fixes, new features, and more. By participating in this project, you agree to abide by our [Code of Conduct](CONDUCT.md).
3+
Welcome to the Viash project, and thank you for considering contributing! We are open to a variety of contributions, including documentation updates, bug fixes, new features, and more.
4+
5+
By participating in this project, you agree to abide by our [Code of Conduct](CONDUCT.md).
6+
7+
Additionally, to ensure we can legally manage and protect the Viash project, all contributors must agree to our [Contributor Assignment Agreement (CAA)](CAA.md). Our automated bot will prompt you to accept this agreement when you submit your first Pull Request.
48

59
## Getting started
610

0 commit comments

Comments
 (0)