best practice template for ESG#34
Open
heckj wants to merge 13 commits into
Open
Conversation
Member
Author
|
/cc @FranzBusch - leaving this in draft state at the moment, can easily adjust to whatever the ESG prefers to use here. |
heckj
changed the title
FranzBusch
reviewed
Feb 26, 2026
heckj
force-pushed
the
practice-template
branch
from
March 13, 2026 17:51
03c763e to
690c644
Compare
Member
Author
|
@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
marked this pull request as ready for review
April 9, 2026 15:19
FranzBusch
reviewed
Apr 9, 2026
heckj
commented
Apr 9, 2026
FranzBusch
reviewed
May 7, 2026
FranzBusch
left a comment
FranzBusch
left a comment
Member
There was a problem hiding this comment.
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?
shahmishal
reviewed
May 11, 2026
FranzBusch
reviewed
May 12, 2026
FranzBusch
reviewed
Jun 1, 2026
shahmishal
reviewed
Jun 1, 2026
…the template provided. Adds structure to host best practices in the future
Co-authored-by: Franz Busch <privat@franz-busch.de>
… sspelling fixes across the two files
…practice-content.md Co-authored-by: Franz Busch <privat@franz-busch.de>
Co-authored-by: Mishal Shah <mishal_shah@apple.com>
…ices - update CODEOWNERS path to /best-practices/ - update snippet path references in template and content guide to BestPractices/Snippets/
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
3 participants
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.
Summary
Provides a template for the Ecosystems Steering Group to utilize for providing guidance when using Swift.
Type of Change
Documentation Package(s) Affected
Changes Made
DocC Markdown template file for a best practice guide/article.
Technical Review Required
Additional Notes
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.