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

Move Release Process pattern to L2 (Structured) #524

Merged

Conversation

dgrizzanti
Copy link
Contributor

Closes #491

@spier let me know what you think about the changes I've made to move this to "Structured". Made a few tweaks. Thanks!

@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 Feb 14, 2023
@spier spier changed the title Move Release Process to structured Move Release Process pattern to L2 (Structured) Feb 14, 2023
@spier
Copy link
Member

spier commented Feb 14, 2023

@robtuley I am a bit tight on time right now. Any chance you could review this PR?

There is a list of possible improvements to the pattern in #491. Comparing this PR to that list would be a good start for a review.

@spier
Copy link
Member

spier commented Feb 14, 2023

Btw the two failing checks "Generate Mindmap" and "Link Check PR" are ok.

The link https://patterns.innersourcecommons.org/p/release-process will only exist once this PR is merged and the new Structured pattern gets published to our online book. Hence immediately after merging the PR, both checks will pass.

@robtuley
Copy link
Collaborator

I can look at this either this evening or tomorrow.

Copy link
Collaborator

@robtuley robtuley left a comment

Choose a reason for hiding this comment

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

This looks good to me, the pattern deserves structured status as it has come together really nicely. Looking back at #491 it covers all those areas.

@robtuley
Copy link
Collaborator

Last step before merge -- @dgrizzanti any thoughts on title before it gets harder to change it?

Standard Release Process and Published Artifacts

Bit long perhaps? Is "Published Artifacts" unnecessary in the title -- i.e. it is part of the release process? Could switch to "Standard Release Process"?

@dgrizzanti
Copy link
Contributor Author

@robtuley shortening the title sounds good to me. I'll update that. The file name is already the shortened form so that helps 🙂

@dgrizzanti
Copy link
Contributor Author

@robtuley should be all set to merge with the updated title!

@spier
Copy link
Member

spier commented Feb 17, 2023

I am changing the points in the associated issue #491 to a checklist, so that we can easier "check the list" lol :)

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 these improvements @dgrizzanti!

The key thing that I would recommend to update before publishing is the Context section, possibly Forces as well.

The Context section doesn't contain the type of content that the pattern template asks for, yet. The two sections Context and Forces are often the hardest to write for new pattern authors, so I would be more than happy to help you to improve this section.

I am a bit short on time right now but I can try to provide an example of an improved Context section some time this weekend.

patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
pattern-categorization/innersource-program-mind-map.md Outdated Show resolved Hide resolved
dgrizzanti and others added 4 commits February 22, 2023 08:33
Also added Standard Base Documentation to this new problem category
Plus a few grammar clean ups
@dgrizzanti dgrizzanti requested review from spier and removed request for NewMexicoKid, lenucksi and cewilliams February 27, 2023 11:26
@dgrizzanti
Copy link
Contributor Author

@spier wanted to ping you to see if you had time to review this. Thanks!

@dgrizzanti
Copy link
Contributor Author

@spier poking on this to see if you had some time to take a look. Thanks!

@spier
Copy link
Member

spier commented May 10, 2023

Hi @dgrizzanti. Just wanted to let you know that I did not forget about this thread, even though it may seem that way :)
Really sorry that I have not been able to work on this sooner. We really appreciate your contribution, and hope to get this merged into the main line, for the benefit of everybody.

I have started a review but it is not quite finished yet.

Stay tuned for more, as they say ;)

@spier
Copy link
Member

spier commented Jun 5, 2023

Hi @dgrizzanti. You have amazing stamina to still keep working on this, even though feedback has been so slow. Really sorry about this, this is not the experience that we want for our contributors!

I promise that I will make my best effort to finish my review this week and send along any remaining questions/ideas that I might have.

Thanks again for your work on this! Have a great day.

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.

@dgrizzanti thanks for discussing this pattern further.

I had some time right now to put more thoughts in writing. Figured it is better to do a quick version of this that we can talk about, to move this PR forward.

Looking forward to your feedback.

patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
pattern-categorization/innersource-program-mind-map.md Outdated Show resolved Hide resolved
patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
patterns/2-structured/release-process.md Outdated Show resolved Hide resolved
@spier
Copy link
Member

spier commented Aug 2, 2023

FYI I merged main into this branch, to make sure that our spell checker runs correctly over this new pattern. Spelling looks all good :)

@dgrizzanti
Copy link
Contributor Author

@spier think I addressed all the new comments and cleaned up a few other small things. Take a look when you get a chance and let me know what you think!

README.md Outdated Show resolved Hide resolved
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 incorporating the feedback.

This looks great now. Let's push it out into the wild, where it can mature further through the contribution of others, shall we? :)

@spier spier merged commit 9c3697a into InnerSourceCommons:main Aug 9, 2023
3 of 5 checks passed
@spier
Copy link
Member

spier commented Aug 9, 2023

@dgrizzanti this pattern is now out in the wild and published in our book:
https://patterns.innersourcecommons.org/p/release-process

Thank you so much for sticking with it and for sharing the concept with the rest of the InnerSource community.

Hopefully other people will pick up on this pattern and use it, as well as contribute their own experiences to the pattern.

As already mentioned, you can expect to be mentioned as the pattern author on our social channels in the coming weeks, and most likely in the September newsletter of the InnerSource Commons as well.

@spier
Copy link
Member

spier commented Aug 9, 2023

Minor note:
The automatic generation of the mindmap is currently broken.
I have to fix that before you can see the changes your pattern show up in the mindmap.

@spier
Copy link
Member

spier commented Aug 9, 2023

Note to self (mostly):
The mindmap got regenerated as a positiv side effect of #568.

i.e. we now got the latest mindmap in our book, which includes the Standard Release Process pattern
https://patterns.innersourcecommons.org/explore-patterns

rmarting pushed a commit to rmarting/InnerSourcePatterns that referenced this pull request Feb 29, 2024
Move Release Process to structured by doing various changes:

* Update title
* Update problem category (in the mindmap). Also added Standard Base Documentation to this new problem category.
* Updates to Context and Force. Plus a few grammar clean ups
* Update Patlet
* Restructure Problem and Context
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.

🚧 Get "Standard Release Process and Published Artifacts" published in our book
4 participants