Skip to content

Conversation

@f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Apr 23, 2025

Description

This PR updates the following:

  • Adds a check for the presence of PR summaries
  • Adds the blog archetypes file (template for blog articles)
  • Improves the contribution guide
  • Improves the summary CSS style
  • In the CI job where summaries are added, update the logic for link checking to trigger only if README.md or content/ were updated

The blog archetype file -- the template for blog articles -- now has guidelines. Some of them were moved from the Contribution guide, others were written anew.

Related

Testing

Tested the CI checks in this PR and in !16.


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow f-hollow force-pushed the ci/check_for_summary branch 5 times, most recently from 49c01b2 to ec8c0fa Compare April 23, 2025 06:23
@f-hollow f-hollow requested review from FBEZ and pedrominatel April 23, 2025 06:25
@f-hollow f-hollow force-pushed the ci/check_for_summary branch 2 times, most recently from e74b4bb to 3f711f3 Compare April 23, 2025 06:42
@f-hollow
Copy link
Collaborator Author

@pedrominatel @FBEZ PTAL

Let me know if anything is not clear enough, I will add more descriptions.

Copy link
Member

@pedrominatel pedrominatel 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 @f-hollow!
Just 2 minor comments. LGTM.

@f-hollow f-hollow force-pushed the ci/check_for_summary branch from ba823a1 to 9f0c996 Compare April 24, 2025 03:42
@f-hollow f-hollow force-pushed the ci/check_for_summary branch from 9f0c996 to b656c4a Compare April 24, 2025 04:04
@f-hollow
Copy link
Collaborator Author

@pedrominatel PTAL again and, if no comments, feel free to merge it.

@pedrominatel
Copy link
Member

@pedrominatel PTAL again and, if no comments, feel free to merge it.

Thanks @f-hollow, LGTM.

@pedrominatel pedrominatel merged commit a015411 into espressif:main Apr 24, 2025
6 checks passed
@f-hollow f-hollow mentioned this pull request Apr 24, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants