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

Create COMMUNICATION-template.md #557

Merged
merged 6 commits into from
Jul 5, 2023
Merged

Conversation

kschueths
Copy link
Contributor

Creating the template file so I have link to add to the base documentation pattern when I add the template to it.

Creating template so I have link to add to the base documentation pattern when I add the template to it.
@spier
Copy link
Member

spier commented Jul 5, 2023

Discussed the approach with @kschueths. As she is mostly working in the GitHub UI when making these contributions, she ended up with a "one file = one PR" approach. Therefore I will go ahead and merge this PR with minor modifications only, so that she can continue the work on the 2nd PR that modifies the pattern itself.

Note that this COMMUNICATION-template.md file won't be shown in our online book until that mentioned future PR is merged.

Lastly, we also discussed that for future contributions that require changes to more than one file, it may be worth trying one of these two options:

  • cloning the repo to your local computer, so that you can work in your regular file system and editor of choice
  • trying GitHub Codespaces (will also work completely in your browser but more like an IDE/editor)

Also worth noting for the Trusted Committers on this repo, as we are helping contributors to make their first contribution, that we have to check their familiarity with the GitHub ecosystem, as that may be quite a roadblock for some.

@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 Jul 5, 2023
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.

Approving this PR, so that @kschueths can continue her work on extending the Standard Base Documentation pattern, which is meant to reference this new template file.

@spier spier merged commit 243f4bc into InnerSourceCommons:main Jul 5, 2023
@spier
Copy link
Member

spier commented Jul 5, 2023

Also note that this PR is related to #535.

@spier spier linked an issue Jul 5, 2023 that may be closed by this pull request
rmarting pushed a commit to rmarting/InnerSourcePatterns that referenced this pull request Feb 29, 2024
Create COMMUNICATION-template.md - Creating template so I have link to add to the base documentation pattern when I add the template to it.

---------

Co-authored-by: Sebastian Spier <[email protected]>
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.

Facilitate Communication with a COMMUNICATION.MD Document
2 participants