Skip to content

best practice template for ESG#34

Open
heckj wants to merge 11 commits into
swiftlang:mainfrom
heckj:practice-template
Open

best practice template for ESG#34
heckj wants to merge 11 commits into
swiftlang:mainfrom
heckj:practice-template

Conversation

@heckj
Copy link
Copy Markdown
Member

@heckj heckj commented Feb 26, 2026

Summary

Provides a template for the Ecosystems Steering Group to utilize for providing guidance when using Swift.

Type of Change

  • Content error fix (corrects inaccurate information)
  • Enhancement (improves existing content)
  • New content (adds new documentation)
  • Technical change (build system, tooling, infrastructure)
  • Typo or formatting fix

Documentation Package(s) Affected

  • API Guidelines
  • Language Guides
  • Server Guides
  • Ecosystem Tools
  • Repository infrastructure

Changes Made

DocC Markdown template file for a best practice guide/article.

Technical Review Required

  • Technical review completed by appropriate CODEOWNERS

Additional Notes


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@heckj
Copy link
Copy Markdown
Member Author

heckj commented Feb 26, 2026

/cc @FranzBusch - leaving this in draft state at the moment, can easily adjust to whatever the ESG prefers to use here.

@heckj heckj changed the title initial stub of a best practice template for ESG best practice template for ESG Feb 26, 2026
Comment thread best-practices/templates/0000-best-practice-template.md
@heckj heckj added the content proposal Proposal for new content label Mar 3, 2026
@heckj heckj force-pushed the practice-template branch from 03c763e to 690c644 Compare March 13, 2026 17:51
@heckj
Copy link
Copy Markdown
Member Author

heckj commented Mar 13, 2026

@FranzBusch I added a "how to create an article" to match the template, and added a placeholder that would easily house future best practices. I didn't put in anything about how the articles are reviewed or vetted, but happy to help write up something with the ESG if the group has a process they'd like to have documented.

@heckj heckj marked this pull request as ready for review April 9, 2026 15:19
@heckj heckj requested a review from a team as a code owner April 9, 2026 15:19
@heckj heckj force-pushed the practice-template branch from 4e2ca16 to da0422f Compare April 9, 2026 15:41
Comment thread ecosystem-tools/Sources/EcosystemTools.docc/Documentation.md Outdated
Copy link
Copy Markdown
Member

@FranzBusch FranzBusch left a comment

Choose a reason for hiding this comment

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

The templates and general doc look good. Can we move all of this to a top level best-practices folder instead of nesting it into ecosystem-tools?

@heckj heckj force-pushed the practice-template branch from 63b0caf to 1613c33 Compare May 7, 2026 15:02
heckj and others added 2 commits May 12, 2026 09:57
…practice-content.md

Co-authored-by: Franz Busch <privat@franz-busch.de>
@heckj heckj requested a review from FranzBusch May 12, 2026 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content proposal Proposal for new content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants