Clarify how to sign actually sign the CLA in the bot comment

Open
#14 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start in clabot/comments.py around line 50 and review the existing CLA bot comment and badge link. Update the comment so contributors can tell how to sign the CLA, incorporating the agreed guidance about the signing page or additional information link; done means the rendered message gives clear signing instructions.

Written by the indexing model from the issue text.

Description

The current CLA bot comment reads:

The following commit authors need to sign the Contributor License Agreement:

CLA signed

I’ve seen some contributors that were confused by this and didn’t realize that they needed to click on the “CLA Not Signed” badge to sign the CLA. Can we make this more clear? Some ideas:

  1. Add an instruction to click on the badge, e.g. “Click the button below to sign”
  2. Mention clicking in the badge text, e.g. “CLA Not Signed - Click Here to Sign”
  3. Include the raw URL to the CLA website, e.g. "visit https://cla.python.org/ to sign"

Also, would it be a good idea to add a link to https://www.python.org/psf/contrib/contrib-form/, which has more information about other options for signing?

Dominant language
Python
Stars
8
Forks
15
Avg merge
7m
Merged PRs (30d)
1

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from psf/clabot

All issues in psf/clabot

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.