You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: BLOG_STYLE_GUIDE.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,16 @@ Welcome to the GraphQL Blog Style Guide! This document outlines best practices a
10
10
11
11
-**Audience First**: Assume the reader has a technical background (developers, engineers) but may be new to GraphQL concepts.
12
12
-**Clarity is Key**: Prioritize clear, concise explanations over jargon. Break down complex ideas with examples.
13
-
-**Vendor neutral**: The GraphQL Blog is about GraphQL as a technology. Vendor specific content and personal promotion doesn't belong in the GraphQL blog.
13
+
-**Vendor neutral**: The GraphQL Blog is about GraphQL as a technology. Vendor specific content and personal promotion doesn't belong in the GraphQL blog.
14
14
15
15
## ℹ️ Content
16
16
17
-
The GraphQL blog welcomes contributions. Anyone may submit a blog post idea by [opening an issue](https://github.com/graphql/graphql.github.io/issues/new) or a draft by [opening a pull request](https://github.com/graphql/graphql.github.io/pulls).
17
+
The GraphQL blog welcomes contributions. Anyone may submit a blog post idea by [opening an issue](https://github.com/graphql/graphql.github.io/issues/new) or a draft by [opening a pull request](https://github.com/graphql/graphql.github.io/pulls).
18
18
19
19
Maintainers are responsible for approving and merging the pull requests.
20
20
21
21
Example content:
22
+
22
23
- Announcements: events, new versions of [GraphQL tools or specifications](https://github.com/orgs/graphql/repositories), updates about the GraphQL foundation, collaborations, etc...
23
24
- Best practices: share learnings and make the best of GraphQL.
24
25
- Case studies: explain how GraphQL helped solve a problem.
@@ -32,23 +33,27 @@ This list is non-exhaustive. If there is something you would like to see on the
32
33
## 📚 Structure
33
34
34
35
### Title
36
+
35
37
- Clear, concise, and descriptive.
36
38
- Avoid clickbait. Example:
37
39
✅ "Understanding GraphQL Subscriptions"
38
40
❌ "This One GraphQL Trick Will Blow Your Mind"
39
41
40
42
### Introduction
43
+
41
44
- Hook the reader in 1–2 sentences.
42
45
- Set clear expectations about what the post covers and who it's for.
43
46
44
47
### Body
48
+
45
49
- Use clear headers (`##`, `###`) to organize sections.
46
50
- Limit paragraphs to 3–5 sentences.
47
51
- Use bullet points or numbered lists for step-by-step content.
48
52
- Include **code samples** where relevant (see Code Style below).
49
53
- Use callouts for **tips**, **warnings**, or **best practices**.
50
54
51
55
### Conclusion
56
+
52
57
- Summarize key takeaways.
53
58
- Link to related resources, docs, or posts.
54
59
- Include a call to action if applicable (e.g., "Try it out", "Join the discussion").
@@ -71,6 +76,7 @@ This list is non-exhaustive. If there is something you would like to see on the
71
76
- Avoid overly long code samples—focus on what supports the topic.
72
77
- Explain what the code is doing either before or after the block.
73
78
- Stick to consistent naming conventions (e.g., `getUser`, `createPostMutation`).
79
+
74
80
---
75
81
76
82
## ✅ Do
@@ -89,4 +95,4 @@ This list is non-exhaustive. If there is something you would like to see on the
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,7 +152,7 @@ Once it's ready for review, please [open a pull request](https://github.com/grap
152
152
153
153
### Add a blog post
154
154
155
-
This repository holds the [graphql.org blog](https://graphql.org/blog/) at [source/src/pages/blog](https://github.com/graphql/graphql.github.io/tree/source/src/pages/blog). Blog posts may contain announcements, news, best practices and more.
155
+
This repository holds the [graphql.org blog](https://graphql.org/blog/) at [source/src/pages/blog](https://github.com/graphql/graphql.github.io/tree/source/src/pages/blog). Blog posts may contain announcements, news, best practices and more.
156
156
157
157
Contributions are very welcome! Please see the [BLOG_STYLE_GUIDE](BLOG_STYLE_GUIDE.md) for more information.
0 commit comments