Skip to content

Commit a8498ec

Browse files
committed
Add CONTRIBUTING.md
1 parent 25d7c3d commit a8498ec

3 files changed

Lines changed: 81 additions & 0 deletions

File tree

.github/workflows/cla.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "CLA Assistant"
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: "CLA Assistant"
20+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
21+
uses: contributor-assistant/github-action@v2.6.1
22+
env:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
# the below token should have repo scope and must be manually added by you in the repository's secret
25+
# This token is required only if you have configured to store the signatures in a remote repository/organization
26+
# PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
27+
with:
28+
path-to-signatures: 'docs/signatures/v1/cla.json'
29+
path-to-document: 'https://github.com/futurewalker-org/futurewalker/blob/main/docs/CLA.md' # e.g. a CLA or a DCO document
30+
# branch should not be protected
31+
branch: 'main'
32+
allowlist: mocabe,bot*
33+
34+
# the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
35+
#remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
36+
#remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository)
37+
#create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
38+
#signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
39+
#custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
40+
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
41+
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
42+
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
43+
#use-dco-flag: true - If you are using DCO instead of CLA

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
Thank you for taking the time to contribute to this project.
4+
5+
If you want to make changes to the codebase, we generally recommend that you open a new issue before submitting PR.
6+
For minor fixes or improvements, you can submit PR directly.
7+
8+
## License
9+
10+
Before submitting PR, please make sure your contribution is your own original work.
11+
12+
You also need to agree that you license your contribution under the [MIT No Attribution License](https://opensource.org/license/mit-0).
13+
This gives us flexibility to manage the project's license, including changing it to the MIT License in the future, or providing a supplemental commercial license to fund the project.
14+
15+
For more details, see [CLA document](./docs/CLA.md) for exact terms of the agreement.
16+
CLA-assistant bot will ask you to sign it on submitting PR.

docs/CLA.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributor License Agreement
2+
3+
For purposes of this Contributor License Agreement ("Agreement"), "Project" means the Futurewalker project, "Contribution" means any code, documentation, or other material that You submit to the Project for inclusion.
4+
5+
By submitting a Contribution, You agree to the following terms:
6+
7+
1. **Authorship.** You either authored the Contribution entirely, or You have the right to submit it under the terms of this Agreement and to grant the rights described herein. If any part of a Contribution was not authored by You, You agree to identify such third-party content and confirm it is submitted under a compatible license.
8+
2. **License.** Each Contribution is licensed by You under the MIT No Attribution License. You agree that anyone may use, copy, modify, and distribute each Contribution under those terms.
9+
10+
---
11+
12+
For reference, the MIT No Attribution License is reproduced below:
13+
14+
```
15+
MIT No Attribution
16+
17+
Copyright <YEAR> <COPYRIGHT HOLDER>
18+
19+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22+
```

0 commit comments

Comments
 (0)