Skip to content

Minor grammar/spelling corrections to various patterns #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Minor grammar/spelling corrections to various patterns #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions patterns/2-structured/30-day-warranty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ A team develops a component which is used throughout an organization. This team
## Forces

- There is distrust of contributions due to a past history of cheating: teams submitted half finished contributions and subsequently filed requests for fixes that make it ready for use in production.
- If code is contributed from outside the team, the team has the natural suspicion that the other team does not know how to write code that would meet the teams expectations.
- If code is contributed from outside the team, the team has the natural suspicion that the other team does not know how to write code that would meet the receiving team's expectations.
- Each team looks first to help its own leaders achieve their own goals. This direction of loyalty can complicate resolution of this problem.
- There is a natural aversion to taking responsibility for code not written by oneself.
- Contributed needs to be heavily rewritten before being accepted into the codebase.
- Contributed code needs to be heavily rewritten before being accepted into the codebase.
- There is the fear of the contributors not being available for support with fixing bugs after the time on contribution.
- Teams fear contributed code will lead to high(er) maintenance costs but do not know how to control for that.
- Receiving teams may fear that teaching others how to contribute code will expose technical debt in their system and that visibility may be damaging.
Expand Down
4 changes: 2 additions & 2 deletions patterns/2-structured/document-your-guiding-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ As a side effect this leads to passive base documentation that is very valuable

(5) Allow written advice to accumulate in a persistent, searchable archive

All project communication, in particular decisions taken and discussions leading up to those decisions need to be archived.
All project communication, in particular decisions taken and discussions leading up to those decisions, need to be archived.
It must be possible to reference communication via stable URLs.
Previous communication needs to be stored in a way that can easily be searched.

Expand All @@ -116,7 +116,7 @@ All Trusted Committers of a project are published.

* Organisation members understand which challenges they can address by applying InnerSource best practices.
* Organisation members lacking prior open source experience understand the basic values and principles of InnerSource projects.
* Organisation members lacking prior open source experience are able to check their daily doing against a set of common established values.
* Organisation members lacking prior open source experience are able to check their daily activities against a set of common established values.
* The organisation's development practices become more similar to open source projects thus making it easier for organisation members to participate in open source projects.

## Known Instances
Expand Down
4 changes: 2 additions & 2 deletions patterns/2-structured/innersource-portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Key properties of the portal are:

* Visitors to the InnerSource Portal should be able to see all available projects as well as search for specific projects based on various criteria such as project name, technologies in use, contributor names, sponsoring business unit etc.
* The information displayed via the InnerSource Portal should be under the full control of the InnerSource project owners at all times. Preferably, by sourcing this information directly from a specific data file or meta-data stored in the project repository itself.
* Project owners should include all relevant information concerning their projects within those data files including the project name, trusted contributors names, a brief description and links to the code repository or any supporting documentation.
* Project owners should include all relevant information concerning their projects within those data files including the project name, trusted contributors' names, a brief description and links to the code repository or any supporting documentation.
* (optional) While most organizations will choose to make their portal only available on their intranet, some organizations have opted to make their portal available on the public internet. The latter can be interesting for organizations that want to show additional information about their InnerSource approach in their portal e.g. for branding and recruitment purposes.

When launching the portal, a communications campaign promoting the addition of InnerSource data files or meta-data to code repositories should be considered, to bolster the number of projects displayed within the portal.
Expand All @@ -65,7 +65,7 @@ A [reference implementation](https://github.com/SAP/project-portal-for-innersour
## Known Instances

* **A large financial services organization** has used the creation of an InnerSource Portal to provide a mechanism of advertising and discovering InnerSource projects in existence across different business units
* **SAP** promotes InnerSource projects in the InnerSource Portal - projects can self-register using GitHub topics. The [Repository Activity Score](repository-activity-score.md) defines the default order of the InnerSource projects in the portal. Also see [Michael Graf & Harish B (SAP) at ISC.S11 - The Unexpected Path of Applying InnerSource Patterns](https://www.youtube.com/watch?v=6r9QOw9dcQo&list=PLCH-i0B0otNQZQt_QzGR9Il_kE4C6cQRy&index=6). It's codebase is published as a [reference implementation](https://github.com/SAP/project-portal-for-innersource) and open for contributions.
* **SAP** promotes InnerSource projects in the InnerSource Portal - projects can self-register using GitHub topics. The [Repository Activity Score](repository-activity-score.md) defines the default order of the InnerSource projects in the portal. Also see [Michael Graf & Harish B (SAP) at ISC.S11 - The Unexpected Path of Applying InnerSource Patterns](https://www.youtube.com/watch?v=6r9QOw9dcQo&list=PLCH-i0B0otNQZQt_QzGR9Il_kE4C6cQRy&index=6). Its codebase is published as a [reference implementation](https://github.com/SAP/project-portal-for-innersource) and open for contributions.
* **Elbit Systems** has used this pattern and added gamification on top.
* [Gamification As Means of Cultural Change and InnerSource Engagement Booster](https://www.oreilly.com/library/view/oscon-2018-/9781492026075/video321579.html) | Shelly Nizri | OSCON 2018 - Portland, Oregon
* Of Islands, Monsters & InnerSource [(slides)](https://docs.google.com/presentation/d/1P1OCEK9B6eSrVRUclVWY6meSI-qHOBjM_UAPNvCZamU/edit#slide=id.p15), [(video)](https://drive.google.com/file/d/1pM89uHMn0vhE3ayFJDGYcCO8R0tAXXZD/view?usp=drivesdk) | InnerSource Spring Summit 2019 (Galway, Ireland)
Expand Down