How to file ICLAs

Open
#125 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Domain
backend

Research direction

No files, tests, or entry points are identified in the issue. Start by locating the ICLA filing workflow and its current filename and index handling; done means selecting and documenting an identifier that minimizes collisions and PII exposure while supporting replacement ICLAs.

Written by the indexing model from the issue text.

Description

ICLAs are currently filed using a filename stem based on the full name.

This approach increasingly suffers from collisions; it also has the potential to expose PII.

We need to find a different identifier where the likelihood of collisions is very small.
Unfortunately humans don't have a unique immutable identifier, at least not one which is likely to be accessible to us.
So some other ID needs to be found.

Some possibilities to consider:

  • UUID generated at time of filing
  • hash of the ICLA file
  • email address (canonicalised if necessary to generate a valid file name stem)

Assuming two people don't share the same email address, all the above should be collision-free for distinct people.

Any others?

Note that whilst the above ids will uniquely identify an ICLA, additional ICLAs from the same person will generally have different ids (email may or may not be the same). This is also true of the full name used in ICLAs: apart from ICLAs which are sent to record a change of name, we sometimes get ICLAs with a different spelling of a name, or with changes to the given names.

The current approach for replacement ICLAs is to create a directory and store all the ICLAs in the same directory.
If email address is used, something similar would be needed.
For the other IDs, the list of files in a directory would need to be replaced with a list of IDs in the index.

Dominant language
Ruby
Stars
126
Forks
101
Avg merge
4h 37m
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

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 apache/whimsy

All issues in apache/whimsy

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.