Skip to content

Commit 49ae122

Browse files
committed
docs(maturity): add capability checklists
#5
1 parent 1862982 commit 49ae122

18 files changed

+7930
-6601
lines changed

.gitmodules

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[submodule "git-tips"]
2+
path = docs/git-tips
3+
url = https://github.com/git-tips/tips.git
4+
[submodule "wiki"]
5+
path = wiki
6+
url = https://github.com/commonality/getting-started-inner-source.wiki.git

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
- [2. Starting an InnerSource product](#2-starting-an-innersource-product)
1111
- [3. How to Contribute to InnerSource](#3-how-to-contribute-to-innersource)
1212
- [4. Finding Consumers for your InnerSource Product](#4-finding-consumers-for-your-innersource-product)
13-
- [5. Building Welcoming Communities](#5-building-welcoming-communities)
13+
- [5. Building Community](#5-building-community)
1414
- [6. Best Practices for Maintainers](#6-best-practices-for-maintainers)
1515
- [7. InnerSource Governance](#7-innersource-governance)
1616
- [8. Code of Conduct](#8-code-of-conduct)
@@ -56,11 +56,11 @@
5656
>
5757
> :soon: Get your product into the happy hands of users and grow your product.
5858
59-
## 5. Building Welcoming Communities
59+
## 5. Building Community
6060

6161
> <img align="bottom" alt="heart" height="80" width="80" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/heart.svg">
6262
>
63-
> :soon: Build a community that encourages employees to use, contribute to, and evangelize your product.
63+
> <img align="left" alt="arrow-right" height="30" width="30" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/arrow-right.svg"> **[Build a community that encourages employees to use, contribute to, and evangelize your product.](docs/communities/README.md)**
6464
6565
## 6. Best Practices for Maintainers
6666

@@ -72,7 +72,7 @@
7272

7373
> <img align="bottom" alt="organization" height="80" width="80" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/organization.svg">
7474
>
75-
> <img align="left" alt="arrow-right" height="30" width="30" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/arrow-right.svg"> **[A governance model gives you _social framework_ for collaboration and consensus with a framework of rules, roles, and responsibilities.](docs/maintainer-guide/governance.md)**
75+
> <img align="left" alt="arrow-right" height="30" width="30" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/arrow-right.svg"> **[A governance model gives you _social framework_ based on transparent rules, roles, and responsibilities that promote collaboration and consensus.](docs/maintainer-guide/governance.md)**
7676
7777
## 8. Code of Conduct
7878

docs/developer-guide/git-cheat-sheet.md

+248
Large diffs are not rendered by default.

docs/developer-guide/vcs-best-practices.md

+256
Large diffs are not rendered by default.

docs/git-tips/.doxie.render.js

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
function escapeStr(str) {
2+
return str
3+
.replace(/\"/g, '\\"')
4+
.replace(/\n/g, '\\n');
5+
}
6+
7+
var render = function(data) {
8+
var data = data.data;
9+
10+
var tips = [
11+
'## ' + data.title,
12+
'```sh',
13+
data.tip,
14+
'```',
15+
'\n'
16+
];
17+
Array.isArray(data.alternatives) && tips.push(['__Alternatives:__']) &&
18+
data.alternatives.map(function(alternative){
19+
tips = tips.concat(['```sh',alternative,'```','\n'])
20+
});
21+
return tips.join('\n');
22+
};
23+
24+
module.exports = render;

docs/git-tips/.doxie.render.toc.js

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// from https://gist.github.com/mathewbyrne/1280286
2+
slugify = function(text){
3+
return text.toString().toLowerCase()
4+
.replace(/\s+/g, '-') // Replace spaces with -
5+
.replace(/[^\w\-]+/g, '') // Remove all non-word chars
6+
.replace(/\-\-+/g, '-') // Replace multiple - with single -
7+
.replace(/^-+/, '') // Trim - from start of text
8+
.replace(/-+$/, ''); // Trim - from end of text
9+
}
10+
11+
var render = function(data) {
12+
var data = data.data;
13+
14+
var out = '* [' + data.title + '](#' + slugify(data.title) + ')\n';
15+
16+
return out;
17+
};
18+
19+
module.exports = render;

docs/git-tips/.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.idea
2+
node_modules
3+
npm-debug.log

docs/git-tips/.vscode/settings.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"eslint.enable": false,
3+
"vsicons.presets.angular": false
4+
}

docs/git-tips/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Hemanth.HM <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)