chore: update contribution and readme with learnings#27
Open
chore: update contribution and readme with learnings#27
Conversation
ShpendKe
requested review from
a team,
CaringDev,
martinkoenig-bbv,
quattervals,
ravicini and
wtjerry
wtjerry
approved these changes
Mar 11, 2026
CONTRIBUTING.md
Outdated
| 2. Include frontmatter (title, description, authors, tags, image) in your post | ||
| 3. Put images in a local `images/` subfolder and reference them relatively (e.g., `./images/cover.png`). | ||
| 6. Ready for review/publish? | ||
| 5. Ready for review/publish? |
Collaborator
There was a problem hiding this comment.
Suggested change
| 5. Ready for review/publish? | |
| 5. Ready for review? |
Collaborator
There was a problem hiding this comment.
Publish sollte nicht vom Autor durchgeführt werden, sondern von den Koordinatoren des Blogs.
CONTRIBUTING.md
Outdated
| 5. Coordinate with maintainers to schedule the publish date (if desired) and merge when ready. As soon as it's merged, it will be live on the blog! No need to wait for a specific publish date. | ||
| 7. Congrats, you published your post! Share it widely and engage with readers in the comments. | ||
| 2. Reference the work item you created in step 1 by mentioning in PR with #{issue-number}. | ||
| 3. If you want, ask somebody for a review. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 3. If you want, ask somebody for a review. | |
| 3. Ask somebody for a review. This should include at least one subject matter expert. |
CONTRIBUTING.md
Outdated
| 7. Congrats, you published your post! Share it widely and engage with readers in the comments. | ||
| 2. Reference the work item you created in step 1 by mentioning in PR with #{issue-number}. | ||
| 3. If you want, ask somebody for a review. | ||
| 4. CI checks passed? Go to next step. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 4. CI checks passed? Go to next step. | |
| 4. CI checks passed? Move your issue to "ready to publish" and inform the blog coordinator or @bbv-blog-admin (github team) to schedule the publish date. |
CONTRIBUTING.md
Outdated
| 2. Reference the work item you created in step 1 by mentioning in PR with #{issue-number}. | ||
| 3. If you want, ask somebody for a review. | ||
| 4. CI checks passed? Go to next step. | ||
| 5. Coordinate with @bbv-blog-admin (github team) to schedule the publish date. When approved by somebody form @bbv-blog-admin. You can merge. As soon as it's merged, it will be live on the blog! No need to wait for a specific publish date. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 5. Coordinate with @bbv-blog-admin (github team) to schedule the publish date. When approved by somebody form @bbv-blog-admin. You can merge. As soon as it's merged, it will be live on the blog! No need to wait for a specific publish date. | |
| 6. Ready to publish. This will be done by the blog coordinator to ensure a regular post publishing. | |
| 1. Adapt the publishing dates in the frontmatter and the directory name of your blog. | |
| 2. Merge the pull request to the main branch. As soon as it's merged, it will be live on the blog! No need to wait for a specific publish date. |
CONTRIBUTING.md
Outdated
| 3. If you want, ask somebody for a review. | ||
| 4. CI checks passed? Go to next step. | ||
| 5. Coordinate with @bbv-blog-admin (github team) to schedule the publish date. When approved by somebody form @bbv-blog-admin. You can merge. As soon as it's merged, it will be live on the blog! No need to wait for a specific publish date. | ||
| 6. Congrats, you published your post! Share it widely and engage with readers in the comments. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 6. Congrats, you published your post! Share it widely and engage with readers in the comments. | |
| 7. Congrats, you published your post! Share it widely and engage with readers in the comments. |
martinkoenig-bbv
requested changes
Mar 12, 2026
Collaborator
martinkoenig-bbv
left a comment
martinkoenig-bbv
left a comment
There was a problem hiding this comment.
Einige Klarstellungen. Wichtig ist mir aber, dass das Publishing nicht vom Autor durchgeführt wird, sonst riskieren wir unregelmässige Veröffentlichungen.
Co-authored-by: martinkoenig-bbv <martin.koenig@bbv.ch>
quattervals
reviewed
Mar 19, 2026
quattervals
left a comment
quattervals
left a comment
There was a problem hiding this comment.
Der Prozess ist ziemlich aufwändig für "nur" ein paar Posts. Weil es aber doch ein paar Feinheiten zu beachten gibt bei professionellem Blogging, halte ich dies für gerechtfertigt.
Die Anleitung halte ich für vollständig und mir ist klar, was es zu tun gibt und warum.
Kein Antrag von mir für Änderungen.
There was a problem hiding this comment.
Pull request overview
Updates repository documentation to reflect current local setup requirements and an updated internal publishing workflow for the Tech Insights Docusaurus blog.
Changes:
- Added explicit Node.js (>= 20) requirements and setup notes to the README.
- Reworked CONTRIBUTING with a “first time contributing” checklist and a more detailed publishing workflow.
- Expanded blog post folder structure + frontmatter/cross-posting guidance and tweaked section headings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Adds environment requirements and turns existing sections into proper markdown headings. |
| CONTRIBUTING.md | Replaces the old post-contribution checklist with a fuller workflow + examples and expanded guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.