Skip to content

Commit a9c0a96

Browse files
committed
formating
1 parent 092ed7e commit a9c0a96

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

BLOG_STYLE_GUIDE.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,16 @@ Welcome to the GraphQL Blog Style Guide! This document outlines best practices a
1010

1111
- **Audience First**: Assume the reader has a technical background (developers, engineers) but may be new to GraphQL concepts.
1212
- **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.
1414

1515
## ℹ️ Content
1616

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).
1818

1919
Maintainers are responsible for approving and merging the pull requests.
2020

2121
Example content:
22+
2223
- Announcements: events, new versions of [GraphQL tools or specifications](https://github.com/orgs/graphql/repositories), updates about the GraphQL foundation, collaborations, etc...
2324
- Best practices: share learnings and make the best of GraphQL.
2425
- 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
3233
## 📚 Structure
3334

3435
### Title
36+
3537
- Clear, concise, and descriptive.
3638
- Avoid clickbait. Example:
3739
✅ "Understanding GraphQL Subscriptions"
3840
❌ "This One GraphQL Trick Will Blow Your Mind"
3941

4042
### Introduction
43+
4144
- Hook the reader in 1–2 sentences.
4245
- Set clear expectations about what the post covers and who it's for.
4346

4447
### Body
48+
4549
- Use clear headers (`##`, `###`) to organize sections.
4650
- Limit paragraphs to 3–5 sentences.
4751
- Use bullet points or numbered lists for step-by-step content.
4852
- Include **code samples** where relevant (see Code Style below).
4953
- Use callouts for **tips**, **warnings**, or **best practices**.
5054

5155
### Conclusion
56+
5257
- Summarize key takeaways.
5358
- Link to related resources, docs, or posts.
5459
- 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
7176
- Avoid overly long code samples—focus on what supports the topic.
7277
- Explain what the code is doing either before or after the block.
7378
- Stick to consistent naming conventions (e.g., `getUser`, `createPostMutation`).
79+
7480
---
7581

7682
## ✅ Do
@@ -89,4 +95,4 @@ This list is non-exhaustive. If there is something you would like to see on the
8995

9096
---
9197

92-
Thank you for contributing to the GraphQL Blog! 🎉
98+
Thank you for contributing to the GraphQL Blog! 🎉

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Once it's ready for review, please [open a pull request](https://github.com/grap
152152

153153
### Add a blog post
154154

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.
156156

157157
Contributions are very welcome! Please see the [BLOG_STYLE_GUIDE](BLOG_STYLE_GUIDE.md) for more information.
158158

0 commit comments

Comments
 (0)