Skip to content
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.

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

Maturity Model: Formatting and grammar updates #538

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

jasonpatrickellykrause
Copy link

  • Updated headings to be heading level 4 instead of emphasizing.
  • Removed unnecessary line breaks.
  • Updated grammar and spelling.

@spier spier changed the title Formatting and grammar updates Maturity Model: Formatting and grammar updates May 11, 2023
@spier spier added 2-structured Patterns with existing instances (Please see our contribution handbook for details) 📖 Type - Content Work Working on contents is the main focus of this issue / PR labels May 11, 2023
@spier
Copy link
Member

spier commented May 11, 2023

@jasonpatrickellykrause thanks for sending these fixes, much appreciated!

A quick question:
is this file essential for this PR?

I have not worked with vscode setting files before, and we don't use them in this repo yet.
So it is a bit hard for me to judge what introducing these means for all users of the repo.

Thanks again for taking the time to improve the pattern!

@jasonpatrickellykrause
Copy link
Author

@jasonpatrickellykrause thanks for sending these fixes, much appreciated!

A quick question: is this file essential for this PR?

I have not worked with vscode setting files before, and we don't use them in this repo yet. So it is a bit hard for me to judge what introducing these means for all users of the repo.

Thanks again for taking the time to improve the pattern!

It is not, my bad!

Copy link
Member

@spier spier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your great work on this.
You caught a number of glitches that we missed in previous reviews.

I went through this one time, and commented on the areas that introduced regressions, and
also asked questions about changes that I was not sure about.

Will merge my non-controversial fixes myself, and then leave the rest to you for review.

Also I think we may want to remove the ".vscode/settings.json" file entirely, or not?

patterns/2-structured/maturity-model.md Outdated Show resolved Hide resolved
patterns/2-structured/maturity-model.md Outdated Show resolved Hide resolved
patterns/2-structured/maturity-model.md Outdated Show resolved Hide resolved
* DP-2: The organization sponsors and promotes a shared repository for collective knowledge. Some teams develop their own CI process, using corporate CI tools. There are CI environments. Code review process defined, and used by some projects. Sometimes code review is done by outside team members.
* DP-0: Each team follows its development process and tools. They are not defined to share knowledge and artifacts outside the development team. Siloed development teams.
* DP-1: Development teams use shared code repositories, internally. Some teams develop their own CI process, using non-corporate or standard CI tools. There is no code review process defined, although some project teams do it internally.
* DP-2: The organization sponsors and promotes a shared repository for collective knowledge. Some teams develop their own CI process, using corporate CI tools. There are CI environments. The code review process is defined, and used by some projects. Sometimes code review is done by outside team members.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* DP-2: The organization sponsors and promotes a shared repository for collective knowledge. Some teams develop their own CI process, using corporate CI tools. There are CI environments. The code review process is defined, and used by some projects. Sometimes code review is done by outside team members.
* DP-2: The organization sponsors and promotes a shared repository for collective knowledge. Some teams develop their own CI process, using corporate CI tools. There are CI environments. A code review process is defined, and used by some projects. Sometimes code review is done by outside team members.

Not sure about the/a here.
Whatever we decide here, we should use the same phrase in DP-3.

* DP-2: The organization sponsors and promotes a shared repository for collective knowledge. Some teams develop their own CI process, using corporate CI tools. There are CI environments. Code review process defined, and used by some projects. Sometimes code review is done by outside team members.
* DP-0: Each team follows its development process and tools. They are not defined to share knowledge and artifacts outside the development team. Siloed development teams.
* DP-1: Development teams use shared code repositories, internally. Some teams develop their own CI process, using non-corporate or standard CI tools. There is no code review process defined, although some project teams do it internally.
* DP-2: The organization sponsors and promotes a shared repository for collective knowledge. Some teams develop their own CI process, using corporate CI tools. There are CI environments. The code review process is defined, and used by some projects. Sometimes code review is done by outside team members.
* DP-3: Most teams develop their own CI process, using corporate CI tools. There are CI environments. Code review process defined, and used. Code review is done by both, internal and external team members.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* DP-3: Most teams develop their own CI process, using corporate CI tools. There are CI environments. Code review process defined, and used. Code review is done by both, internal and external team members.
* DP-3: Most teams develop their own CI process, using corporate CI tools. There are CI environments. A code review process is defined, and used. Code review is done by both, internal and external team members.

patterns/2-structured/maturity-model.md Outdated Show resolved Hide resolved
* MP-2: There is a strategy at the organizational level with respect to metrics that help to validate specific policies across the organization. This monitoring policy exists at the level of some InnerSource projects.
* MP-3: There are clear guidelines, recommendations, and trainings about the use of metrics with certain infrastructure provided by the organization. This works at both levels: InnerSource program to understand the general InnerSource adoption within the organization, and at the level of InnerSource projects.
* MP-2: There is a strategy at the organizational level concerning metrics that help to validate specific policies across the organization. This monitoring policy exists at the level of some InnerSource projects.
* MP-3: There are clear guidelines, recommendations, and training about the use of metrics with certain infrastructures provided by the organization. This works at both levels: InnerSource program to understand the general InnerSource adoption within the organization and at the level of InnerSource projects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious: Does it have to be the plural of "infrastructure" here?

patterns/2-structured/maturity-model.md Outdated Show resolved Hide resolved
patterns/2-structured/maturity-model.md Outdated Show resolved Hide resolved

There are multiple levels moving towards a collaborative culture.
Multiple levels are moving towards a collaborative culture.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this changes the meaning completely. Not sure if we should do this.

@spier
Copy link
Member

spier commented May 11, 2023

Btw I don't know how gitbook (where we host the patterns for our readers) will format the H4 heading nicely. But we shall see. This is how it looks like in gitbook before this change: https://patterns.innersourcecommons.org/p/maturity-model

@spier
Copy link
Member

spier commented May 22, 2023

@jasonpatrickellykrause I added the vale style/spell checker, and through that I also made some fixes in the maturity model. This unfortunately lead to some conflicts with your PR here.

Would you mind checking those, and also the comments I left inline on this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2-structured Patterns with existing instances (Please see our contribution handbook for details) 📖 Type - Content Work Working on contents is the main focus of this issue / PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants