Skip to content

Commit 1168a5e

Browse files
NewMexicoKidgruetterlenucksirrrutledgespier
authored
Create assisted_compliance.md (#74)
Create assisted_compliance.md pattern. This is: Helping repo owners be compliant by writing their CONTRIBUTING.md for them as a pull request. Pattern from 2017. Co-authored-by: Georg Grütter <[email protected]> Co-authored-by: Johannes Tigges <[email protected]> Co-authored-by: rrrutledge <[email protected]> Co-authored-by: rrrutledge <[email protected]> Co-authored-by: Sebastian Spier <[email protected]>
1 parent 9ea67cb commit 1168a5e

File tree

2 files changed

+72
-1
lines changed

2 files changed

+72
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ The below lists all known patterns. They are grouped into three [maturity levels
5454

5555
#### Pattern Drafts (proven, not yet fully reviewed)
5656

57-
* [Assisted Compliance](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/74) - *Helping repo owners be compliant by writing their CONTRIBUTING.md for them as a pull request.*
5857
* [What Before How or Services Documentation](https://docs.google.com/document/d/1_N1wsQeDusfIcNy-O2ZXenY3PL7ZbvkUDRZxGUuegZw/edit?usp=drive_web) - *A lack of common understanding between different management tiers creates funding barriers and increases the risk that solutions will not deliver required business outcomes.*
5958
* [Open Source Trumps InnerSource](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/46) - *People find the InnerSource project but, after all things are considered, even if the InnerSource component meets their needs, they still go with the open source component.*
6059

@@ -77,6 +76,7 @@ The below lists all known patterns. They are grouped into three [maturity levels
7776
* [Explaining InnerSource to Management by anchoring it to Agile / DevOps / Lean](patterns/1-initial/concept-anchor.md)
7877
* [Reluctance to Receive Contributions](patterns/1-initial/reluctance-to-accept-contributions.md) - *Core owner of shared asset is reluctant to take contributions due to the required maintenance that comes with them. Summary pattern that lays out four children patterns with three to be defined.*
7978
* [Include Product Owners](patterns/1-initial/include-product-owners.md) - *Engaging and educating Product Owners about InnerSource can help them modify their actions (e.g., in the space of KPIs) to help InnerSource collaboration work better.*
79+
* [Assisted Compliance](patterns/1-initial/assisted_compliance.md) - *Helping repo owners be compliant by writing their CONTRIBUTING.md for them as a pull request.*
8080

8181
#### Donuts (needing a solution)
8282

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## Title
2+
3+
Assisted Compliance
4+
5+
## Patlet
6+
7+
TBD
8+
9+
## Problem
10+
11+
The team that owns the repository doesn't have a `CONTRIBUTING.md`; the task force needs them to have this to submit bug fixes.
12+
13+
## Context
14+
15+
* Teams owning the repository are not complying with mandates for having a `CONTRIBUTING.md`
16+
* Compliance guys have to do a job; this is made difficult by teams resisting this.
17+
* Teams owning the repository resist compliance-related mandates for having a `CONTRIBUTING.md`. Having this file is mandated in support of the InnerSource program, to ensure that there is a known and stated process for submitting PRs and having them be appropriately checked and accepted.
18+
* Special task force for security and compliance: developers responsible for fixing these bugs across the company.
19+
* Negotiations are being held but they are slow and little progress is made.
20+
* The task force is discovering the needed information for a `CONTRIBUTING.md` as they investigate the problem.
21+
* There is a checklist for being InnerSource compliant.
22+
* There is a need to be Security compliant.
23+
* There may be export control compliance and legal compliance requirements; a template is provided to repository owners
24+
25+
## Forces
26+
27+
* Teams have been resisting this; this ends up wasting time.
28+
* Making documents part of the repo skeleton might be "rubber stamping"; better to have teams own this. So too much automation in this case is bad.
29+
30+
## Solution
31+
32+
* Rather than asking the resisting team to do the changes, the policing task force that discovers the lack of compliance create the documentation (in addition to negotiations)
33+
* Taking the contributor perspective (contributors are motivated). They are writing the `CONTRIBUTING.md` documentation for those teams resistant to doing the fixes, doing this as pull requests. The discussion is then documented in the pull request. The resisting development teams then just correct mistakes.
34+
* "Let us help you be compliant"
35+
* You could do an audit to assess the state of compliance. Bots could be used to check compliance; and the state of compliance could show up in an internal portal.
36+
37+
## Resulting Context
38+
39+
* Contributors become InnerSource champions; they both teach and guide those through the process in a gentler fashion than it would have been done before.
40+
* Many projects pop up without governance; the first chance to interact with them is to help them setup their `README.md` and be compliant.
41+
* We increase the overall compliance and the chance of getting more contributions from the outside. This ultimately helps the team in question to get more work done.
42+
43+
## Known Instances
44+
45+
TBD
46+
47+
## Status
48+
49+
Initial
50+
51+
## Alias
52+
53+
* Helping repo owners be compliant by writing their CONTRIBUTING.md for them as a pull request
54+
* Let us help you be compliant
55+
56+
## Authors
57+
58+
* Silona Bonewald
59+
* Georg Gruetter
60+
61+
## Acknowledgements
62+
63+
* Erin Bank
64+
* Tim Yao
65+
66+
## References
67+
68+
For anyone starting further work on this pattern, e.g. to level it up to the next maturity, there are some interesting discussions from the time when this pattern was created.
69+
70+
* Idea to generalize this pattern to include files such as `SUPPORT.md` and `CODE_OF_CONDUCT.md` - see [conversation](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/74#issuecomment-715498921)
71+
* Idea for tooling to automatically generate files such as `CONTRIBUTING.md` - see [conversation](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/74#discussion_r168596722).

0 commit comments

Comments
 (0)