Skip to content
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

EasyCLA PR: User-Email Level Signature Details #169

Closed
jpalmerLinuxFoundation opened this issue Aug 29, 2019 · 6 comments
Closed

EasyCLA PR: User-Email Level Signature Details #169

jpalmerLinuxFoundation opened this issue Aug 29, 2019 · 6 comments
Labels
03 - Med Medium Priority enhancement New feature or request GitHub Integration needs-investigation A feature or issue that requires more detailed analysis/estimation to define the scope. size:TBD Size is too be determined after analysis tier-3 An issue or feature that is considered a tier 3 priority issue

Comments

@jpalmerLinuxFoundation
Copy link
Contributor

jpalmerLinuxFoundation commented Aug 29, 2019

Summary
The projects would like a way to understand better why the CLA check is failing.
Which of the contributors is NOT covered by a signed CLA?

Background
Scenario: CLA check fails

  1. Go to a repo with EasyCLA configured, and you have a signed CLA covering you (ICLA or CCLA)
  2. Create a PR
  3. When the user fails the CLA check then comment is posted to the PR with a link
  4. User clicks on the link to confirm affiliation/sign ICLA
  5. [Change] EasyCLA page will display details about why the PR CLA check is failing
    • See attached mockups
    • Notice:
      - Clear status: Failed, not all contributors covered by a signed CLA
      - User-Level Status indicated by Checkmark or Red 'X' (See comment for images)
      - User's Email(s) are displayed. If a contributor has more than one email, display both
      - Display inline list of PR SHA's for each user
      - ACTION applicable for contributor:
      - Share this URL with the individuals who are not covered by a CLA
      - Click on the appropriate link below and complete the CLA signing process

User Story
As a project maintainer and committer
I need to see why the CLA is failing
so that I can effectively troubleshoot the issue and sign if necessary.

Acceptance Criteria
The "done" criteria when this feature or problem is resolved. Such as:

  1. Unit Tests added and running in CI
  2. Functional Tests updated to cover feature, if applicable
  3. Demonstrate the set of capabilities to the product team while the code is
    running in the STAGING environment.

References

  1. CLAbot is lacking logs  cncf/foundation#26
  2. Open source CLAbot cncf/foundation#3

Mockups
Scenario: User who is not covered clicks on link
image

Scenario: Someone other than the not-covered user views the page (Anyone but the person who needs to sign)
image

@jpalmerLinuxFoundation jpalmerLinuxFoundation added the enhancement New feature or request label Aug 29, 2019
@jpalmerLinuxFoundation jpalmerLinuxFoundation changed the title EasyCLA Log Details for Troubleshooting EasyCLA PR: User-Email Level Signature Details Aug 29, 2019
@jpalmerLinuxFoundation jpalmerLinuxFoundation added the 03 - Med Medium Priority label Aug 29, 2019
@jpalmerLinuxFoundation
Copy link
Contributor Author

jpalmerLinuxFoundation commented Aug 29, 2019

20 X 20 px (2)
icon-pr-cla-failed
icon-pr-cla-passing

Hyperlink text color: #3F6AAA

@dims
Copy link

dims commented Aug 29, 2019

Thanks @jpalmerLinuxFoundation

@jtattermusch
Copy link

I think the main point in #177 was for the details to be displayed as a "github status check" (shows up under the "Checks" tab on given PR, clicking the "Details" link in the commit status brings you to that tab). github status check API provides support just for that and it's the new standard for displaying detailed check info on PRs.

@jpalmerLinuxFoundation
Copy link
Contributor Author

So, we're asking for it to show check details here, correct?
image

@jtattermusch
Copy link

@jpalmerLinuxFoundation yes, it seems to be an ideal place to show the check result details and also for links to additional documentation/instructions (what sometimes happen is that users have trouble with the CLA and we manually have to guide them to do the right thing, which is timeconsuming - if the check had a clear link for instructions / troubleshooting, it would help IMHO).

@jpalmerLinuxFoundation jpalmerLinuxFoundation added backlog post v2 scope v2 and removed backlog post v2 scope labels Sep 27, 2019
@dealako dealako added needs-investigation A feature or issue that requires more detailed analysis/estimation to define the scope. size:TBD Size is too be determined after analysis and removed v2 labels Nov 26, 2019
@pranab-bajpai pranab-bajpai added this to the Sprint 11 milestone Dec 3, 2019
@dealako dealako modified the milestones: Sprint 11, Sprint 4 - July 27-August 10, 2020 Nov 30, 2020
@dealako dealako added the tier-3 An issue or feature that is considered a tier 3 priority issue label Nov 30, 2020
@dealako
Copy link
Member

dealako commented Aug 22, 2022

Closing issue due to inactivity. Please re-open or raise a new ticket if this issue/feature is required.

@dealako dealako closed this as completed Aug 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
03 - Med Medium Priority enhancement New feature or request GitHub Integration needs-investigation A feature or issue that requires more detailed analysis/estimation to define the scope. size:TBD Size is too be determined after analysis tier-3 An issue or feature that is considered a tier 3 priority issue
Projects
None yet
Development

No branches or pull requests

5 participants