Skip to content

Commit 886525c

Browse files
authored
Community blog post submission process changes (#190)
* First draft of the community blog post submission process changes. * Removed mention of the release schedule after PR feedback.
1 parent 9b418b1 commit 886525c

File tree

6 files changed

+53
-11
lines changed

6 files changed

+53
-11
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ Swift.org contributions must adhere to the website's [governance process](https:
4040

4141
## Blog Posts
4242

43-
Blog posts are covered by a [separate governance process](https://www.swift.org/website-governance/#blog-posts-governance) which has a more extensive review process. You should [reach out to the SWWG](https://forums.swift.org/new-message?groupname=swift-website-workgroup) if you would like to contribute a post. This can encompass sharing language changes, libraries and tools and highlighting work done by the community.
44-
45-
Please note that pull requests for blog posts that have not been discussed with the SWWG will be rejected, with the exception of minor updates to existing posts like typos.
43+
Blog posts are covered by a [separate governance process](https://www.swift.org/website-governance/#blog-posts-governance). Community-contributed blog posts are welcome through the [community blog post submission process](http://swift.org/blog-post-contributions/).
4644

4745
## Community Participation
4846

_data/navigation.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@
101101
name: triaging-bugs
102102
- title: Swift Evolution
103103
name: evolution-process
104+
- title: Blog Post Contributions
105+
name: blog-post-contributions
104106
- title: Contributing Code
105107
name: contributing-code
106108
- title: Adding External Library Dependencies

blog-post-contributions/index.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: page
3+
title: Blog Post Contributions
4+
---
5+
6+
The [Swift.org blog](https://www.swift.org/blog/) helps to keep the Swift community informed of recent developments in the language, the release roadmap, interesting new features, libraries, tools, and announcing project & community initiatives. It is central to Diversity in Swift’s mission to recognize and highlight work across the community. We welcome blog post contributions from everyone, regardless of background or experience.
7+
8+
Are you doing interesting things using Swift? The community would love to hear how you’ve been using the language. See the process below for details on how to submit a blog post.
9+
10+
## Community Contributed Content
11+
12+
Blog posts don’t necessarily need to be technical, and your writing can appeal to anyone from beginners to language experts. Did you have an unusual journey towards Swift? Share that story. Did you use Swift code to interact with some hardware or in another context that people might not expect? That sounds great. Is there a previously covered topic you’d like to take further? Adding your experience and perspective is valuable.
13+
14+
Readers have different backgrounds and experiences, but you can assume a basic knowledge of the Swift language.
15+
16+
Is there anything to avoid in a Swift.org blog post? There’s a short list:
17+
18+
* Directly commercial content promoting a product, service, or event.
19+
* Launch announcements for apps or libraries. While a blog post could talk about a new Swift language library or package, it should not be the post’s focus. The [Community Showcase](https://forums.swift.org/c/community-showcase/66) section of the Swift forums is ideal for community announcements.
20+
21+
All Swift.org blog posts are published under a Creative Commons Attribution 4.0 International license. You may re-publish your work on your own website under this license with appropriate attribution.
22+
23+
## Writing Guidelines
24+
25+
Blog posts on Swift.org don’t need to be written in a particular style, but there are some guidelines below that will help make a great post:
26+
27+
* Write inclusively and respectfully according to the Swift.org Code of Conduct.
28+
* There’s no set length for a blog post, but between 500 and 1,000 words is typical.
29+
* Screenshots, illustrations, code snippets, and links to documentation or other websites can be worth a thousand words.
30+
* You can write alone or in a small group. It’s up to you.
31+
32+
## Submission Process
33+
34+
Submit ideas or drafts of blog posts by [sending a message to the @swift-website-workgroup](https://forums.swift.org/new-message?groupname=swift-website-workgroup&title=Blog%20post%20proposal). Be sure to include some details about what you’d like to contribute in your post:
35+
36+
* Either a first draft or a few paragraphs that summarise your post idea.
37+
* Whether your post or the topic it covers is time-sensitive and any information on why.
38+
* Your name and Swift forum username. If you are writing as a group, include everyone.
39+
40+
The [Swift Website Workgroup]({% link website-workgroup/index.md %}) discusses blog post pitches bi-weekly and will reply to all submissions.
41+
42+
Like all contributions to this website, the [Swift.org website governance]({% link website-governance/index.md %}) process covers all blog post submissions.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Website and Blog Post Contributions
2+
3+
The Swift project welcomes suggestions and enhancements to this website and community blog post contributions showcasing initiatives and stories across the community. The [Swift Website Workgroup]({% link website-workgroup/index.md %}) oversees all website and blog post contributions.
4+
5+
Learn more about contributing to this website in the [Swift.org website governance]({% link website-governance/index.md %}) process and about how to [submit blog post contributions]({% link blog-post-contributions/index.md %}).

contributing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ as described in [Source Code](/source-code).
2020
{% include_relative _answering-questions.md %}
2121
{% include_relative _reporting-bugs.md %}
2222
{% include_relative _triaging-bugs.md %}
23+
{% include_relative _website-and-blog-post-contributions.md %}
2324
{% include_relative _swift-evolution-process.md %}
2425
{% include_relative _contributing-code.md %}
2526
{% comment %}{% include_relative _contributing-documentation.md %}{% endcomment %}
@@ -28,4 +29,3 @@ as described in [Source Code](/source-code).
2829
* * *
2930

3031
{% include_relative _llvm.md %}
31-

website-governance/index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,9 @@ Larger changes to content, such as introducing broad new topics, require consult
2626

2727
### Blog posts governance
2828

29-
The Swift.org blog is designed to keep the Swift community informed of recent development in the language, its ecosystem, and news about the community itself.
29+
The Swift.org blog is designed to keep the Swift community informed of recent development in the language, its ecosystem, and news about the community. It is a platform for sharing the language roadmap, interesting new features, libraries, and tools, and announcing project & community initiatives.
3030

31-
The blog is a platform for sharing the language roadmap and release schedule, interesting new features, libraries, and tools, and announcing project & community initiatives.
32-
33-
The blog is also an opportunity to recognize and highlight the work being done by developers across our community.
34-
However, contributions to the Swift.org blog have a more extensive review process, and will not be accepted by direct pull request, with the exception of minor changes like typo fixes.
35-
36-
Community-focused content on the blog is facilitated by the [website workgroup](/website-workgroup); reach out to [@swift-website-workgroup](https://forums.swift.org/new-message?groupname=swift-website-workgroup) if you’re interested in contributing to the Swift.org blog.
31+
The blog is also an opportunity to recognize and highlight the work being done by members of our community, and we welcome post contributions through the [blog post contribution process]({% link blog-post-contributions/index.md %}).
3732

3833
### Swift libraries documentation and "The Swift Programming Language"
3934

0 commit comments

Comments
 (0)