Skip to content

Commit

Permalink
docs(maturity): add capability checklists
Browse files Browse the repository at this point in the history
  • Loading branch information
gregswindle committed Jul 19, 2018
1 parent 1862982 commit 49ae122
Show file tree
Hide file tree
Showing 18 changed files with 7,930 additions and 6,601 deletions.
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[submodule "git-tips"]
path = docs/git-tips
url = https://github.com/git-tips/tips.git
[submodule "wiki"]
path = wiki
url = https://github.com/commonality/getting-started-inner-source.wiki.git
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- [2. Starting an InnerSource product](#2-starting-an-innersource-product)
- [3. How to Contribute to InnerSource](#3-how-to-contribute-to-innersource)
- [4. Finding Consumers for your InnerSource Product](#4-finding-consumers-for-your-innersource-product)
- [5. Building Welcoming Communities](#5-building-welcoming-communities)
- [5. Building Community](#5-building-community)
- [6. Best Practices for Maintainers](#6-best-practices-for-maintainers)
- [7. InnerSource Governance](#7-innersource-governance)
- [8. Code of Conduct](#8-code-of-conduct)
Expand Down Expand Up @@ -56,11 +56,11 @@
>
> :soon: Get your product into the happy hands of users and grow your product.
## 5. Building Welcoming Communities
## 5. Building Community

> <img align="bottom" alt="heart" height="80" width="80" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/heart.svg">
>
> :soon: Build a community that encourages employees to use, contribute to, and evangelize your product.
> <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)**
## 6. Best Practices for Maintainers

Expand All @@ -72,7 +72,7 @@

> <img align="bottom" alt="organization" height="80" width="80" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/organization.svg">
>
> <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)**
> <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)**
## 8. Code of Conduct

Expand Down
248 changes: 248 additions & 0 deletions docs/developer-guide/git-cheat-sheet.md

Large diffs are not rendered by default.

256 changes: 256 additions & 0 deletions docs/developer-guide/vcs-best-practices.md

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions docs/git-tips/.doxie.render.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
function escapeStr(str) {
return str
.replace(/\"/g, '\\"')
.replace(/\n/g, '\\n');
}

var render = function(data) {
var data = data.data;

var tips = [
'## ' + data.title,
'```sh',
data.tip,
'```',
'\n'
];
Array.isArray(data.alternatives) && tips.push(['__Alternatives:__']) &&
data.alternatives.map(function(alternative){
tips = tips.concat(['```sh',alternative,'```','\n'])
});
return tips.join('\n');
};

module.exports = render;
19 changes: 19 additions & 0 deletions docs/git-tips/.doxie.render.toc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// from https://gist.github.com/mathewbyrne/1280286
slugify = function(text){
return text.toString().toLowerCase()
.replace(/\s+/g, '-') // Replace spaces with -
.replace(/[^\w\-]+/g, '') // Remove all non-word chars
.replace(/\-\-+/g, '-') // Replace multiple - with single -
.replace(/^-+/, '') // Trim - from start of text
.replace(/-+$/, ''); // Trim - from end of text
}

var render = function(data) {
var data = data.data;

var out = '* [' + data.title + '](#' + slugify(data.title) + ')\n';

return out;
};

module.exports = render;
3 changes: 3 additions & 0 deletions docs/git-tips/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.idea
node_modules
npm-debug.log
4 changes: 4 additions & 0 deletions docs/git-tips/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"eslint.enable": false,
"vsicons.presets.angular": false
}
21 changes: 21 additions & 0 deletions docs/git-tips/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Hemanth.HM <hemanth.hm@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 49ae122

Please sign in to comment.