This document explains how to set up automated CLA checking for Speakr.
CLA Assistant - A free, open-source GitHub Action that automatically:
- Comments on PRs asking contributors to sign the CLA
- Tracks who has signed
- Blocks PR merging until CLA is signed
- Stores signatures in a JSON file
The CLA Assistant needs a GitHub Personal Access Token to create commits for storing signatures.
-
Go to GitHub Settings → Developer Settings → Personal Access Tokens → Tokens (classic)
- Or visit: https://github.com/settings/tokens
-
Click "Generate new token" → "Generate new token (classic)"
-
Give it a descriptive name:
Speakr CLA Assistant -
Set expiration:
No expiration(or your preferred duration) -
Select scopes:
- ✅
repo(Full control of private repositories) - ✅
workflow(Update GitHub Action workflows)
- ✅
-
Click "Generate token"
-
IMPORTANT: Copy the token immediately (you won't see it again!)
-
Go to your repository: https://github.com/murtaza-nasir/speakr
-
Navigate to: Settings → Secrets and variables → Actions
-
Click "New repository secret"
-
Name:
PERSONAL_ACCESS_TOKEN -
Value: Paste the token you copied in step 1
-
Click "Add secret"
The files have been created locally. Commit them:
git add CLA.md CONTRIBUTING.md .github/workflows/cla.yml .github/CLA-SETUP.md
git commit -m "Add Contributor License Agreement and automated CLA checking"
git pushThe CLA Assistant will store signatures in a separate branch:
# Create and push the signatures branch
git checkout -b cla-signatures
git push -u origin cla-signatures
git checkout master # or mainAdd a badge to show CLA status. Add this near the top of README.md:
[](https://cla-assistant.io/murtaza-nasir/speakr)Add a link in the Contributing section:
## Contributing
We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) to learn about our CLA process and development workflow.-
Create a test PR from a different account or ask someone to create one
-
The CLA bot should automatically comment asking for signature
-
They sign by commenting:
I have read the CLA Document and I hereby sign the CLA -
The bot updates the PR with a success message
- They open a PR
- Bot comments with CLA instructions
- They read CLA.md
- They comment:
I have read the CLA Document and I hereby sign the CLA - Bot records signature in
.github/signatures/cla.jsononcla-signaturesbranch - Bot marks PR as CLA-signed ✅
- Future PRs from same user are auto-approved
- You'll see CLA status checks on PRs
- Signatures are stored in
.github/signatures/cla.json - You can manually check signatures anytime
- Merging is only possible after CLA is signed
All signatures are stored in:
https://github.com/murtaza-nasir/speakr/blob/cla-signatures/.github/signatures/cla.json
Format:
{
"signedContributors": [
{
"name": "username",
"id": 12345,
"comment_id": 67890,
"created_at": "2025-01-18T12:34:56Z",
"repoId": 123456789,
"pullRequestNo": 42
}
]
}- Check that PERSONAL_ACCESS_TOKEN secret is set
- Verify token has correct permissions
- Check GitHub Actions are enabled for repo
- Look at Actions tab for error logs
git checkout -b cla-signatures
git push -u origin cla-signatures
git checkout masterTo remove all signatures (use carefully!):
git checkout cla-signatures
rm .github/signatures/cla.json
git commit -m "Reset CLA signatures"
git pushDelete their entry from .github/signatures/cla.json and commit:
git checkout cla-signatures
# Edit .github/signatures/cla.json to remove the user
git add .github/signatures/cla.json
git commit -m "Remove CLA signature for username"
git push
git checkout masterYou can customize the CLA bot messages by editing .github/workflows/cla.yml:
custom-notsigned-prcomment- Message shown to unsigned contributorscustom-pr-sign-comment- Message after signingcustom-allsigned-prcomment- Message when all have signedallowlist- Users who don't need to sign (bots, etc.)
If you want something simpler, consider using Developer Certificate of Origin (DCO) instead:
- Contributors add
Signed-off-by: Name <email>to commits - No separate signature required
- Less formal but still legally binding
- Used by Linux kernel and many projects
Let me know if you'd prefer DCO instead!
- CLA Assistant Docs: https://github.com/contributor-assistant/github-action
- Issues with setup? Open an issue in this repo