Skip to content

Commit 9e94e7e

Browse files
authored
Merge pull request #112 from StingRayZA/2019-summit-workshop
Draft pattern: Who is using my code?
2 parents c176c08 + 48fb471 commit 9e94e7e

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

patterns/1-initial/code-consumers.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Title
2+
3+
Code Consumers
4+
5+
# Patlet
6+
TBD
7+
8+
# Problem
9+
There's several reasons why we might want to know who's using (consuming) our code. We can't do the following:
10+
* notify downstream users/projects of found (fixed?) vulnerabilities
11+
* audit flow of IP
12+
* kill off code - knowing where (or if) it is used
13+
* encourage others to use a project - by showing how many users there already are
14+
* survey users for feedback
15+
16+
# Context
17+
This is a general issue that affects potentially all InnerSource (and open source!) projects.
18+
The act of opening code allows people to use it without letting you know.
19+
20+
# Forces
21+
* The harder it is to download/integrate the project, the less it will be adopted (forcing people to give information when they use it adds barriers)
22+
* Not all projects may want you to know what they're using (tightly closed source/top secret downstream project)
23+
* Putting in callback/call home routines into projects may introduce distrust in downstream projects and users
24+
25+
# Solutions
26+
The following are potential solutions that have been proposed to this problem:
27+
* Scan all output artifacts for known signatures (manifests/npm/includes etc)
28+
* Voluntary disclosure/signup upon installation/using
29+
* Search for identifiers/markers in source control
30+
* Audit code clones/artifact downloads
31+
* Incentivise/Offer users a mailing list/update stream to which they can subscribe
32+
33+
# Resulting Context
34+
_needs work..?_
35+
36+
# Known Instances
37+
_needs work...?_
38+
39+
# Authors
40+
* Georg Grütter (Robert Bosch GmbH)
41+
* Raimund Hook (EXFO Inc)
42+
* Katrina Novakovic (RedHat)
43+
44+
# Status
45+
Drafted at the 2019 Spring InnerSource Commons Summit in Galway - 10 April 2019
46+

0 commit comments

Comments
 (0)